添加一些注释

main.js

@@ -1374,13 +1374,22 @@ module.exports = {
         username: '',
         password: ''
       },
-      isLogin: false
+      isLogin: false // 是否已登录
     }
   },
   methods: {
+    /**
+     * @description: 扫码登录
+     * @return {*}
+     */
     showQrcode() {
       console.log("扫码登录");
     },
+    /**
+     * @description: mousedown 事件
+     * @param {*} e
+     * @return {*}
+     */
     mousedownFn(e) {
       // mounted里获取不到dragDiv和moveDiv的offsetWidth，所以暂时在这取值
       if (!this.maxwidth) {
@@ -1391,7 +1400,11 @@ module.exports = {
         this.mouseMoveStata = true;
         this.beginClientX = e.clientX;
       }
-    }, //mousedoen 事件
+    },
+    /**
+     * @description: 验证成功函数
+     * @return {*}
+     */
     successFunction() {
       this.confirmSuccess = true;
       this.confirmWords = "验证通过";
@@ -1403,7 +1416,12 @@ module.exports = {
       }
       this.$refs.moveBgDiv.style.left = this.maxwidth + "px";
       this.$refs.dragBg.style.width = this.maxwidth + "px";
-    }, //验证成功函数
+    },
+    /**
+     * @description: mousemove事件
+     * @param {*} e
+     * @return {*}
+     */
     mouseMoveFn(e) {
       if (this.mouseMoveStata) {
         let width = e.clientX - this.beginClientX;
@@ -1414,7 +1432,12 @@ module.exports = {
           this.successFunction();
         }
       }
-    }, //mousemove事件
+    },
+    /**
+     * @description: mouseup事件
+     * @param {*} e
+     * @return {*}
+     */
     moseUpFn(e) {
       this.mouseMoveStata = false;
       var width = e.clientX - this.beginClientX;
@@ -1422,19 +1445,21 @@ module.exports = {
         this.$refs.dragBg.style.width = 0 + "px";
         this.$refs.moveBgDiv.style.left = 0 + "px";
       }
-    }, //mouseup事件
+    },
-    // 设置监听事件
+    /**
+     * @description: 设置监听事件
+     * @return {*}
+     */
     setEventListener() {
       if (!this.isLogin) {
         this.$refs.moveDiv.addEventListener("mousemove", this.mouseMoveFn);
         this.$refs.moveDiv.addEventListener("mouseup", this.moseUpFn);
       }
     },
-    resetMoveDiv() {
+    /**
-      this.setEventListener();
+     * @description: 登录接口
-      this.confirmSuccess = false;
+     * @return {*}
-      this.confirmWords = "按住滑块滑动，拖到最右边";
+     */
-    },
     async login() {
       if (this.loginForm.username && this.loginForm.password && this.confirmSuccess) {
         const res = await Panel.login(this.loginForm);
@@ -1541,8 +1566,7 @@ const store = __webpack_require__(/*! ../store/index.js */ "./src/store/index.js
 module.exports = {
   data() {
     return {
-      curpanel: "selected", // 选择的画板
+      curpanel: "selected", // 选择画板的方式
-      // artboardsName: [],
       state: store.state,
       showArtboardsName: [],
       projects: [
@@ -1560,21 +1584,43 @@ module.exports = {
     }
   },
   methods: {
-    // 画板单选框改变
+    /**
+     * @description: 选择画板方式的单选框改变
+     * @return {*}
+     */
     getRadioVal() {
       this.curpanel === "selected" && (this.showArtboardsName = this.state.artboardsName);
       this.curpanel === "all" && (this.showArtboardsName = this.state.allArtboardsName);
     },
-    // 选择框选项改变
+    /**
+     * @description: select选项改变
+     * @param {*} e
+     * @param {*} prop: select绑定的参数名
+     * @return {*}
+     */
     changeOption(e, prop) {
       this[prop] = e.target.value;
     },
+    /**
+     * @description: 打开“新建版本”弹窗
+     * @return {*}
+     */
     toNewVer() {
       if (this.dialog) {
         this.dialog.showModal();
       }
     },
-    // 覆盖上传
+    /**
+     * @description: 关闭“新建版本”弹窗
+     * @return {*}
+     */
+    close() {
+      this.dialog.close();
+    },
+    /**
+     * @description: 覆盖上传
+     * @return {*}
+     */
     toUpload() {
       // const msg = {
       //   curpanel: this.curpanel,
@@ -1583,9 +1629,10 @@ module.exports = {
       // }
       // console.log("上传信息:", msg);
     },
-    close() {
+    /**
-      this.dialog.close();
+     * @description: 获取项目名称列表
-    },
+     * @return {*}
+     */
     async getProjectList() {
       const data = {
         pageSize: 10,
@@ -10920,6 +10967,11 @@ __webpack_require__.r(__webpack_exports__);
 
 
 class Panel {
+  /**
+   * @description: 登录接口
+   * @param {*} data
+   * @return {*}
+   */
   static async login(data) {
     try {
       const res = await _xhr_js__WEBPACK_IMPORTED_MODULE_0__["default"].post('/teamco-dev/sys/loginNoCode', data);
@@ -10928,6 +10980,11 @@ class Panel {
       return false
     }
   }
+  /**
+   * @description: 项目名称列表接口
+   * @param {*} data
+   * @return {*}
+   */
   static async getProjectList(data) {
     try {
       const res = await _xhr_js__WEBPACK_IMPORTED_MODULE_0__["default"].get('/teamco-dev/project/info/jhTcProjectInfo/list', data);
@@ -10950,22 +11007,35 @@ class Panel {
 
 "use strict";
 __webpack_require__.r(__webpack_exports__);
+/**
+ * @description: 封装一个类，能给 localStorage 存储的值设置过期时间，如给存储在本地的用于登录 token 设置过期时间
+ */
 class Storage {
   constructor(name) {
     this.name = 'storage';
   }
-  //设置缓存
+  /**
-  setItem(name, value, expires = null) {
+   * @description: 设置缓存
+   * @param {*} keyName: 要创建或更新的键名
+   * @param {*} keyValue: 要创建或更新的键名对应的值
+   * @param {*} expires: 过期时间，单位：秒
+   * @return {*}
+   */
+  setItem(keyName, keyValue, expires = null) {
     const options = {
-      value: value,
+      keyValue: keyValue,
       expires: expires ? expires * 1000 : null,
       startTime: expires ? new Date().getTime() : 0
     }
-    localStorage.setItem(name, JSON.stringify(options));
+    localStorage.setItem(keyName, JSON.stringify(options));
   }
-  //拿到缓存
+  /**
-  getItem(name) {
+   * @description: 返回对应键名的值
-    let item = localStorage.getItem(name);
+   * @param {*} keyName: 一个包含键名的 DOMString
+   * @return {*} 一个 DOMString，键名对应的值。如果键名不存在于存储中，则返回 null
+   */
+  getItem(keyName) {
+    let item = localStorage.getItem(keyName);
     if (item === null) return null;
     item = JSON.parse(item);
     //如果有 startTime 的值，说明设置了失效时间
@@ -10974,22 +11044,29 @@ class Storage {
       //何时将值取出减去刚存入的时间，与item.expires比较，如果大于就是过期了，如果小于或等于就还没过期
       if (date - item.startTime > item.expires) {
         //缓存过期，清除缓存，返回false
-        localStorage.removeItem(name);
+        localStorage.removeItem(keyName);
         return null;
       } else {
         //缓存未过期，返回值
-        return item.value;
+        return item.keyValue;
       }
     } else {
       //如果没有设置失效时间，直接返回值
-      return item.value;
+      return item.keyValue;
     }
   }
-  //移出缓存
+  /**
-  removeItem(name) {
+   * @description: 接受一个键名作为参数，从 localStorage 对象中删除该键名
-    localStorage.removeItem(name);
+   * @param {*} keyName: 想要移除的键名
+   * @return {*}
+   */
+  removeItem(keyName) {
+    localStorage.removeItem(keyName);
   }
-  //移出全部缓存
+  /**
+   * @description: 清空存储对象里所有的键值
+   * @return {*}
+   */
   clear() {
     localStorage.clear();
   }
@@ -11010,6 +11087,11 @@ class Storage {
 __webpack_require__.r(__webpack_exports__);
 const { TEAMCO_BASE_URL } = __webpack_require__(/*! ../const.js */ "./src/const.js");
 
+/**
+ * @description: 将对象转可拼接到 url 后的字符串
+ * @param {Object} data
+ * @return {*}
+ */
 const getQueryString = (data) => {
   let paramsArr = [];
   if (data && data instanceof Object) {
@@ -11022,6 +11104,11 @@ const getQueryString = (data) => {
   return ''
 }
 
+/**
+ * @description: 简单封装 XMLHttpRequest
+ * @param {*} settings
+ * @return {*}
+ */
 function xhrBinary(settings) {
   const headers = settings.headers || {};
   let reqCfg = {
@@ -11136,7 +11223,12 @@ const App = __webpack_require__(/*! ./App.vue */ "./src/App.vue").default;
 const store = __webpack_require__(/*! ./store/index.js */ "./src/store/index.js").default;
 const Storage = __webpack_require__(/*! ./api/storage.js */ "./src/api/storage.js").default;
 
-function show() {
+/**
+ * @description: one of the lifecycle methods for a panel plugin(is required), called when your plugin is made visible to the user
+ * @param {*} event: includes a node property that you can attach your user interface to
+ * @return {*}
+ */
+function show(event) {
   document.body.innerHTML = `<div id="app"></div>`;
   Vue.prototype.$store = store;
   Vue.prototype.$storage = new Storage();
@@ -11144,14 +11236,20 @@ function show() {
     render: h => h(App)
   }).$mount('#app')
   let html = document.getElementsByTagName("html")[0];
-  // html.style.width = "375px";
   html.style.backgroundColor = "#ffffff";
   // let body = document.getElementsByTagName("body")[0];
   // body.classList.remove("uxp-plugin");
 }
-function update(selection, SceneNode) {
+/**
-  console.log(selection);
+ * @description: an optional function 
-  store.setAllArtboardsAction(SceneNode.children);
+ *               called whenever the user changes the selection in the XD document or mutates a node within that selection
+ *               provides two arguments, selection and documentRoot
+ * @param {*} selection
+ * @param {*} documentRoot
+ * @return {*}
+ */
+function update(selection, documentRoot) {
+  store.setAllArtboardsAction(documentRoot.children);
   const { Artboard } = __webpack_require__(/*! scenegraph */ "scenegraph");
   if (!selection || !(selection.items[0] instanceof Artboard)) {
     store.clearArtboardsAction();

src/App.vue

@@ -99,13 +99,22 @@ module.exports = {
         username: '',
         password: ''
       },
-      isLogin: false
+      isLogin: false // 是否已登录
     }
   },
   methods: {
+    /**
+     * @description: 扫码登录
+     * @return {*}
+     */
     showQrcode() {
       console.log("扫码登录");
     },
+    /**
+     * @description: mousedown 事件
+     * @param {*} e
+     * @return {*}
+     */
     mousedownFn(e) {
       // mounted里获取不到dragDiv和moveDiv的offsetWidth，所以暂时在这取值
       if (!this.maxwidth) {
@@ -116,7 +125,11 @@ module.exports = {
         this.mouseMoveStata = true;
         this.beginClientX = e.clientX;
       }
-    }, //mousedoen 事件
+    },
+    /**
+     * @description: 验证成功函数
+     * @return {*}
+     */
     successFunction() {
       this.confirmSuccess = true;
       this.confirmWords = "验证通过";
@@ -128,7 +141,12 @@ module.exports = {
       }
       this.$refs.moveBgDiv.style.left = this.maxwidth + "px";
       this.$refs.dragBg.style.width = this.maxwidth + "px";
-    }, //验证成功函数
+    },
+    /**
+     * @description: mousemove事件
+     * @param {*} e
+     * @return {*}
+     */
     mouseMoveFn(e) {
       if (this.mouseMoveStata) {
         let width = e.clientX - this.beginClientX;
@@ -139,7 +157,12 @@ module.exports = {
           this.successFunction();
         }
       }
-    }, //mousemove事件
+    },
+    /**
+     * @description: mouseup事件
+     * @param {*} e
+     * @return {*}
+     */
     moseUpFn(e) {
       this.mouseMoveStata = false;
       var width = e.clientX - this.beginClientX;
@@ -147,19 +170,21 @@ module.exports = {
         this.$refs.dragBg.style.width = 0 + "px";
         this.$refs.moveBgDiv.style.left = 0 + "px";
       }
-    }, //mouseup事件
+    },
-    // 设置监听事件
+    /**
+     * @description: 设置监听事件
+     * @return {*}
+     */
     setEventListener() {
       if (!this.isLogin) {
         this.$refs.moveDiv.addEventListener("mousemove", this.mouseMoveFn);
         this.$refs.moveDiv.addEventListener("mouseup", this.moseUpFn);
       }
     },
-    resetMoveDiv() {
+    /**
-      this.setEventListener();
+     * @description: 登录接口
-      this.confirmSuccess = false;
+     * @return {*}
-      this.confirmWords = "按住滑块滑动，拖到最右边";
+     */
-    },
     async login() {
       if (this.loginForm.username && this.loginForm.password && this.confirmSuccess) {
         const res = await Panel.login(this.loginForm);

src/api/artboards.js

@@ -1,6 +1,11 @@
 import api from "./xhr.js";
 
 class Panel {
+  /**
+   * @description: 登录接口
+   * @param {*} data
+   * @return {*}
+   */
   static async login(data) {
     try {
       const res = await api.post('/teamco-dev/sys/loginNoCode', data);
@@ -9,6 +14,11 @@ class Panel {
       return false
     }
   }
+  /**
+   * @description: 项目名称列表接口
+   * @param {*} data
+   * @return {*}
+   */
   static async getProjectList(data) {
     try {
       const res = await api.get('/teamco-dev/project/info/jhTcProjectInfo/list', data);

src/api/storage.js

@@ -1,19 +1,32 @@
+/**
+ * @description: 封装一个类，能给 localStorage 存储的值设置过期时间，如给存储在本地的用于登录 token 设置过期时间
+ */
 class Storage {
   constructor(name) {
     this.name = 'storage';
   }
-  //设置缓存
+  /**
-  setItem(name, value, expires = null) {
+   * @description: 设置缓存
+   * @param {*} keyName: 要创建或更新的键名
+   * @param {*} keyValue: 要创建或更新的键名对应的值
+   * @param {*} expires: 过期时间，单位：秒
+   * @return {*}
+   */
+  setItem(keyName, keyValue, expires = null) {
     const options = {
-      value: value,
+      keyValue: keyValue,
       expires: expires ? expires * 1000 : null,
       startTime: expires ? new Date().getTime() : 0
     }
-    localStorage.setItem(name, JSON.stringify(options));
+    localStorage.setItem(keyName, JSON.stringify(options));
   }
-  //拿到缓存
+  /**
-  getItem(name) {
+   * @description: 返回对应键名的值
-    let item = localStorage.getItem(name);
+   * @param {*} keyName: 一个包含键名的 DOMString
+   * @return {*} 一个 DOMString，键名对应的值。如果键名不存在于存储中，则返回 null
+   */
+  getItem(keyName) {
+    let item = localStorage.getItem(keyName);
     if (item === null) return null;
     item = JSON.parse(item);
     //如果有 startTime 的值，说明设置了失效时间
@@ -22,22 +35,29 @@ class Storage {
       //何时将值取出减去刚存入的时间，与item.expires比较，如果大于就是过期了，如果小于或等于就还没过期
       if (date - item.startTime > item.expires) {
         //缓存过期，清除缓存，返回false
-        localStorage.removeItem(name);
+        localStorage.removeItem(keyName);
         return null;
       } else {
         //缓存未过期，返回值
-        return item.value;
+        return item.keyValue;
       }
     } else {
       //如果没有设置失效时间，直接返回值
-      return item.value;
+      return item.keyValue;
     }
   }
-  //移出缓存
+  /**
-  removeItem(name) {
+   * @description: 接受一个键名作为参数，从 localStorage 对象中删除该键名
-    localStorage.removeItem(name);
+   * @param {*} keyName: 想要移除的键名
+   * @return {*}
+   */
+  removeItem(keyName) {
+    localStorage.removeItem(keyName);
   }
-  //移出全部缓存
+  /**
+   * @description: 清空存储对象里所有的键值
+   * @return {*}
+   */
   clear() {
     localStorage.clear();
   }

src/api/xhr.js

@@ -1,5 +1,10 @@
 const { TEAMCO_BASE_URL } = require("../const.js");
 
+/**
+ * @description: 将对象转可拼接到 url 后的字符串
+ * @param {Object} data
+ * @return {*}
+ */
 const getQueryString = (data) => {
   let paramsArr = [];
   if (data && data instanceof Object) {
@@ -12,6 +17,11 @@ const getQueryString = (data) => {
   return ''
 }
 
+/**
+ * @description: 简单封装 XMLHttpRequest
+ * @param {*} settings
+ * @return {*}
+ */
 function xhrBinary(settings) {
   const headers = settings.headers || {};
   let reqCfg = {

src/main.js

@@ -6,7 +6,12 @@ const App = require("./App.vue").default;
 const store = require("./store/index.js").default;
 const Storage = require("./api/storage.js").default;
 
-function show() {
+/**
+ * @description: one of the lifecycle methods for a panel plugin(is required), called when your plugin is made visible to the user
+ * @param {*} event: includes a node property that you can attach your user interface to
+ * @return {*}
+ */
+function show(event) {
   document.body.innerHTML = `<div id="app"></div>`;
   Vue.prototype.$store = store;
   Vue.prototype.$storage = new Storage();
@@ -14,14 +19,20 @@ function show() {
     render: h => h(App)
   }).$mount('#app')
   let html = document.getElementsByTagName("html")[0];
-  // html.style.width = "375px";
   html.style.backgroundColor = "#ffffff";
   // let body = document.getElementsByTagName("body")[0];
   // body.classList.remove("uxp-plugin");
 }
-function update(selection, SceneNode) {
+/**
-  console.log(selection);
+ * @description: an optional function 
-  store.setAllArtboardsAction(SceneNode.children);
+ *               called whenever the user changes the selection in the XD document or mutates a node within that selection
+ *               provides two arguments, selection and documentRoot
+ * @param {*} selection
+ * @param {*} documentRoot
+ * @return {*}
+ */
+function update(selection, documentRoot) {
+  store.setAllArtboardsAction(documentRoot.children);
   const { Artboard } = require("scenegraph");
   if (!selection || !(selection.items[0] instanceof Artboard)) {
     store.clearArtboardsAction();

src/views/UploadArtboards.vue

@@ -74,8 +74,7 @@ const store = require('../store/index.js').default;
 module.exports = {
   data() {
     return {
-      curpanel: "selected", // 选择的画板
+      curpanel: "selected", // 选择画板的方式
-      // artboardsName: [],
       state: store.state,
       showArtboardsName: [],
       projects: [
@@ -93,21 +92,43 @@ module.exports = {
     }
   },
   methods: {
-    // 画板单选框改变
+    /**
+     * @description: 选择画板方式的单选框改变
+     * @return {*}
+     */
     getRadioVal() {
       this.curpanel === "selected" && (this.showArtboardsName = this.state.artboardsName);
       this.curpanel === "all" && (this.showArtboardsName = this.state.allArtboardsName);
     },
-    // 选择框选项改变
+    /**
+     * @description: select选项改变
+     * @param {*} e
+     * @param {*} prop: select绑定的参数名
+     * @return {*}
+     */
     changeOption(e, prop) {
       this[prop] = e.target.value;
     },
+    /**
+     * @description: 打开“新建版本”弹窗
+     * @return {*}
+     */
     toNewVer() {
       if (this.dialog) {
         this.dialog.showModal();
       }
     },
-    // 覆盖上传
+    /**
+     * @description: 关闭“新建版本”弹窗
+     * @return {*}
+     */
+    close() {
+      this.dialog.close();
+    },
+    /**
+     * @description: 覆盖上传
+     * @return {*}
+     */
     toUpload() {
       // const msg = {
       //   curpanel: this.curpanel,
@@ -116,9 +137,10 @@ module.exports = {
       // }
       // console.log("上传信息:", msg);
     },
-    close() {
+    /**
-      this.dialog.close();
+     * @description: 获取项目名称列表
-    },
+     * @return {*}
+     */
     async getProjectList() {
       const data = {
         pageSize: 10,