前端注释规范

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",
},
相关推荐
拖孩24 分钟前
# 我又用 AI 做了个小程序:24 天,记录我这辈子认识的人
前端·后端·微信小程序
徐小夕33 分钟前
深度拆解 Design Agent:LangChain 出品,AI 设计从「好看」走向「可用」
前端·vue.js·github
1-1=01 小时前
Vue 表单数据和过滤器
前端·javascript·vue.js
oil欧哟1 小时前
Oil UI 的设计思路与日常使用方式:让 AI 摆脱默认模板并保持多页面风格统一
前端
恋猫de小郭2 小时前
Jetpack Compose 1.13 发布,憋了这么久终有交代了
android·前端·flutter
头发还在的女程序员2 小时前
智慧物业源码解析:房屋档案与业主变更怎样保持历史业务连续
前端·javascript·vue.js·物业管理·小区物业·智慧物业
JianZhen✓2 小时前
电商 SKU 选择器:后端只给扁平列表,前端怎么反推规格矩阵并做到 O(1) 命中
前端·矩阵·状态模式
feixing_fx11 小时前
第一个 JS 程序:在浏览器控制台和 Node 中分别运行
开发语言·前端·javascript·前端框架·ecmascript
feixing_fx12 小时前
变量与声明:let、const、var 的选择边界
开发语言·前端·javascript·前端框架
JavaGuide14 小时前
Cloudflare 开源的这套神级安全审计 Skill 太好用了!
前端·后端