前端注释规范

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",
},
相关推荐
Flynt3 分钟前
Chrome给AI编程助手塞了203篇前端规范,我拆包实测:检索0.77秒是真快,扫描器有点挑食
前端·chrome·ai编程
北城笑笑27 分钟前
Vue 110 ,若依SSE流式接口限次空500排查与解决
前端·javascript·vue.js·后端·vue
程序员韩星1 小时前
OpenAI 兼容接口返回 404,先查请求地址,再查模型名
前端·人工智能·http
Patrick_Wilson1 小时前
构建通过了,为什么有些浏览器还会白屏?
前端·javascript·浏览器
其实防守也摸鱼2 小时前
用 Claude Code 重构遗留系统:从评估到落地的完整指南
前端·网络·人工智能·chrome·安全·重构
七仔啊2 小时前
CNC计算机数控加工模拟器
前端
张一凡932 小时前
你的 AGENTS.md,真的管到模型写代码了吗?
前端·后端·agent
Brookty2 小时前
CSS基础知识(一):选择器、优先级、层叠与继承、边框属性及盒模型
前端·css
颜进强3 小时前
微信小微AI-灰度与命中排查|代码全对、版本已发,为什么同事就是问不中?
前端·ai编程·全栈
verohh3 小时前
从代码组织到功能抽象:AI 时代的前端工程架构设计
前端