前端注释规范

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",
},
相关推荐
deli0074 分钟前
TCP 为什么会粘包?4 种拆包方案 49 字节实测对比
前端
deli0071 小时前
32K 上下文塞满后,AI 最先忘掉什么?120 轮对话实测
前端
deli0072 小时前
手机拍灯为什么有一条条黑纹?PWM 240Hz 实测
前端
wangruofeng7 小时前
AI Models 1.1.0 发布,查大模型价格、对比模型和找 API 地址
前端·aigc·ai编程
wangruofeng7 小时前
给前端开发者的 100 个设计参考网站
前端·设计
星栈10 小时前
视频即代码,Remotion 能做什么、不能做什么
前端·音视频开发
广州华水科技10 小时前
单北斗GNSS位移监测系统的应用与技术解析
前端
用户479492835691510 小时前
从一句话或代码仓到可交互 HTML:开源 Agent 画图技能 Archify v3.2 实测与选型边界
前端·后端·面试
风骏时光牛马13 小时前
生成一个AI多模态标题,仅输出一条标题,无额外文字、问句、备选、配图、文案等任何附加内容,不需要其他的任务服务 只要标题。
前端
wangruofeng13 小时前
从 GIF 到 AVIF:网页图片格式演进与 2026 年选型指南
前端·架构