Merge pull request #1 from JSREI/doc/add-code-comment

Doc/add code comment

Author: CC11001100

Diff for: LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 CC11001100
+Copyright (c) 2022 JavaScript Reverse Engineering Infrastructure
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Diff for: main.js

@@ -8,12 +8,18 @@ class WindowMonitor {
         this.windowListenerQueue = [];
     }
 
+    /**
+     * 增加一个window上新增或者删除变量时的监听器回调函数
+     *
+     * @param windowListener
+     * @returns {Promise<void>}
+     */
     async addWindowListener(windowListener) {
         this.windowListenerQueue.push(windowListener);
     }
 
     /**
-     * 启动window监控器
+     * 启动window监控器，其实就是异步移动一个while循环每隔 intervalMils 秒去检查一下window上是否有变量变化
      *
      * @param intervalMils 间隔多少毫秒检查一次，默认为300毫秒
      * @returns {Promise<void>}
@@ -30,25 +36,38 @@ class WindowMonitor {
         }
     }
 
+    /**
+     *  对window上的变量做快照，如果有必要的话，则会与上一次的快照做diff尝试触发事件
+     *
+     * @param isInit 是否是第一次初始化，如果是初始化则只对window上的变量做快照，否则会与前一次的变量快照做diff尝试触发事件
+     * @returns {Promise<void>}
+     */
     async screenshotWindow(isInit) {
         for (let key in window) {
 
-            // 已经存在的情况
+            // 变量已经存在的情况
             if (this.windowAttributeSet.has(key)) {
                 continue;
             }
 
-            // 触发新增事件
+            // 触发变量新增事件
             if (!isInit) {
                 for (let callback of this.windowListenerQueue) {
                     callback(key)
                 }
             }
 
+            // 把新增的变量记录一下
             this.windowAttributeSet.add(key);
         }
     }
 
+    /**
+     * 休眠给定的毫秒数
+     *
+     * @param mils 要休眠的毫秒数
+     * @returns {Promise<number>}
+     */
     async sleep(mils) {
         return new Promise((resolve) => setTimeout(resolve, mils));
     }