代码注释规则|技术点评

140 阅读1分钟

注释让项目更加丝滑

讲个笑话: 小明在对之前项目进行维护的时候大骂其中的功能 写的就是一坨x直呼要功能作者以死谢罪 总监知道后也直言要扣绩效,  在查看提交记录的过程中 小明就像是祥林嫂一样呢喃着 不可能啊 不可能啊 哦 原来是小明自己写的啊

变量需要注释

  1. 需要变量说明 说明你的变量作用

image.png

函数需要多行注释

  1. 需要参数说明 函数作用
  2. 在函数中超过十行需要阶段说明
  3. 方法中添加你需要的部分功能阶段说明

组件需要传入注释

  1. 传入参数需要类型和功能
  2. 需要在props中定义参数的类型和默认值

文件注释

  1. 文件头部需要加上注释 说明文件是干什么的
    image.png

以上在Vuex上同样成立

链接:pan.baidu.com/s/1wxaLohzw… 提取码:5ff5 webstorm导入流程 导入完毕后就可以用快捷键了

image.png

  • 本文正在参与「掘金 2021 春招闯关活动」, 点击查看 活动详情