前端注释规范

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",
},
相关推荐
10年前端老司机1 小时前
React无限级菜单:一个项目带你突破技术瓶颈
前端·javascript·react.js
阿芯爱编程5 小时前
2025前端面试题
前端·面试
前端小趴菜057 小时前
React - createPortal
前端·vue.js·react.js
晓13137 小时前
JavaScript加强篇——第四章 日期对象与DOM节点(基础)
开发语言·前端·javascript
菜包eo7 小时前
如何设置直播间的观看门槛,让直播间安全有效地运行?
前端·安全·音视频
烛阴8 小时前
JavaScript函数参数完全指南:从基础到高级技巧,一网打尽!
前端·javascript
chao_7899 小时前
frame 与新窗口切换操作【selenium 】
前端·javascript·css·selenium·测试工具·自动化·html
天蓝色的鱼鱼9 小时前
从零实现浏览器摄像头控制与视频录制:基于原生 JavaScript 的完整指南
前端·javascript
三原9 小时前
7000块帮朋友做了2个小程序加一个后台管理系统,值不值?
前端·vue.js·微信小程序
popoxf9 小时前
在新版本的微信开发者工具中使用npm包
前端·npm·node.js