代码注释的使用

一.html注释规范

1.模块化注释: 每个模块 添加开合和闭合标签，闭合标签以 空格 + end结尾

<!-- 注释内容 -->
    // 标签...
<!-- 注释内容 end-->

2.区块注释

/**
 * @name: xxxx
 * @description: xxx
 * @author: xxx
 * @后台人员: xxx
 */

二、JavaScript 注释规范

1.变量注释: // 双斜杠

// 用单行注释来备注简单的数据信息

const name = ""; // 名称
const id = ""; // 项目id

// xxx函数
const getDetail = () => {};

2.业务函数注释: // 或者 /** */

/**
 * 获取数据
 */

getData () {
  // todo
},

// 获取数据

getData () {
  // todo
},

/**
 * xxxx获取详情
 * @param params
 * @returns {*}
 */

export function getData(params) {}

三、CSS 注释规范

1.单个注释：// 双斜杠（必须独占一行。//后跟一个空格，缩进与下一行被注释说明的代码一致。）

// XXX样式
.column-color {
  color: #409EFF;
  cursor: pointer;
}

2.模块化注释: 每个模块样式 添加开合和闭合标签，闭合标签以 空格 + end结尾

/* 注释内容 */
.body{
  padding: 0;
  margin: 0;
}
/* 注释内容 end */