注释分类

根据使用hooks文件目录分类时注释可以划分为以下几种类型,能让用户更容易的去理解文件代码

  • 组件的页面级注释
  • HandleJs逻辑处理文件的注释
  • HooksJs状态文件的处理
  • 普通函数方法的注释

    常规组件的注释

    ```javascript /*
    • @Name: 组件名称
    • @State: [state1, state2, …]
    • @Function: [function1, function2, ….]
    • @Component: [Table(内部组件库的table组件)]
    • @Author: SQYun
    • @Date: 2020-10-14 14:11:48 */
  1. <a name="bUQKs"></a>
  2. ## HandleJS文件的注释
  3. ```javascript
  4. /*
  5.  * @Name: 函数的逻辑处理
  6.  * @ToolFunctions: [
  7.  *  getListFromDictionary(获取对应的值),
  8.  *  clearBlankStringFromObject(清除空字符串),
  9.  *  getValueByKey(根据key查询对应的值)
  10.  * ]
  11.  * @Function: [
  12.  *  createColumns(table列的生成),
  13.  *  createPromise(table数据的请求),
  14.  *  createHandleBarOptions(操作配置项生成),
  15.  *  createSearchBarOptions(搜索栏配置项生成)
  16.  * ]
  17.  * @Author: SQYun
  18.  * @Date: 2020-10-22 10:47:00
  19.  */

HooksJs文件的注释

  1. /*
  2.  * @Name: 组件名称
  3.  * @Props: [props1(参数1), props2(参数2), ...]
  4.  * @State: [state1(状态1), state2(状态2), ...]
  5.  * @Ref: [ref1(ref对象1), ref2(ref对象2), ]
  6.  * @Effect: [effect1(), effect2()]
  7.  * @Function: [function1, function2, ...]
  8.  * @Return: [
  9.  *  state1(返回的状态1),
  10.  *  state2(返回的状态2),
  11.  *  function1(返回的方法1),
  12.  *  function2(返回的方法2),
  13.  *  ...
  14.  * ]
  15.  * @Author: SQYun
  16.  * @Date: 2020-10-22 11:22:46
  17.  */

Function方法的注释

  1. /**
  2.  * @name 方法名 不复杂时, 可与description留其一
  3.  * @description: 方法的描述
  4.  * @param {type} param1 传入文件的参数
  5.  * @return {type} returnValue 函数返回的结果
  6.  */

注释插件

写注释时，并不需要自己一行行的写，可使用一些插件来简化你的编写量
插件推荐：koroFileHeader