前端注释规范

1、目的和原则

提高可读性和可维护性

如无必要,无增注释;如有必要,尽量详尽

2、语法

单行注释: //

多行注释: /**/

3、规范

1、注释符与注释内容之间加一个空格

2、注释行与上方代码间加一个空行

4、Javascript

为函数的入参与输出做详细注释,便于使用者一目了然功能与所需参数;

bash 复制代码
    /**
    * 函数描述
    * 与此函数相关联引入的其他函数,并说明该函数具体位置以及说明其功能
    * @param {string} p1 参数1的说明
    * @param {string} p2 参数2的说明,比较长
    *     那就换行了.
    * @param {number=} p3 参数3的说明(可选)
    * @return {Object} 返回值描述
    */

5、文件头部信息注释

vscode 插件 koroFileHeader 可配置自动生成头部信息

bash 复制代码
"fileheader.customMade": {
  "Author": "git config user.name", //作者
  "Email": "git config user.email", //邮箱
  "Description": "功能或页面描述",
  "Date": "Do not edit", //文件生成时间
  "LastEditors": "git config user.name", //最后更改人
  "LastEditTime": "Do not edit",
},
相关推荐
嘻嘻嘻嘻嘻嘻ys33 分钟前
《Spring Boot 3 + GraalVM原生镜像实战:云原生时代的毫秒启动与性能调优》
前端·后端
嘻嘻嘻嘻嘻嘻ys36 分钟前
《Spring Boot 3.0×GraalVM:云原生时代的毫秒级启动实战革命》
前端·后端
嘻嘻嘻嘻嘻嘻ys38 分钟前
《Vue 3.4响应式内核优化与WebAssembly性能突破实战指南》
前端·后端
嘻嘻嘻嘻嘻嘻ys40 分钟前
《Spring Boot 3百万并发实战:基于JDK21虚拟线程的性能革新》
前端·后端
一天睡25小时1 小时前
前端性能优化面试回答技巧(一)
前端·面试
樊小肆1 小时前
Vue3 在线 PDF 编辑 2.0 缩放拖拽、渲染优化功能解析
前端·vue.js·开源
程序员韩立1 小时前
精通 React Hooks:从核心技巧到自定义实践
前端
WEI_Gaot1 小时前
React Hooks useRef useId
前端·react.js
一天睡25小时1 小时前
视频HLS分片与关键帧优化深度解析
前端·javascript
孤鸿玉1 小时前
[Flutter小试牛刀] 低配版signals,添加多层监听链
android·前端·响应式设计