前端开发规范(注释规范)

vlambda
2021-08-02

前端开发规范(注释规范)

如何写好一个注释也是非常重要的，为了保持大家风格一致，代码整洁规范显得极其重要

单行注释

英文
中文
句首加空格
句尾不加标点符号（!除外）

// init user namelet userName = "AK SYA";
// 检查用户名是否为好名字const isGoodName = userName.includes("AK-SYA");

多行注释

英文
中文
尽量使用Markdown标记语言进行编写（或IDE的注释插件）

/** * 将两个数字求和，并返回结果。 * @param numA 参数A，纯数字 * @param numB 参数B，纯数字 */export function sum(numA: number, numB: number): number { return numA + numB;}
/** * 处理`Request`对象的处理器。 * * @用法 * - 解析请求体 * - 分发请求到控制器 * - 所有请求记录到日志 * * @备注 * 此处理器只能处理`Node`的请求对象，请勿使用封装后的对象。 */export class RequestHandler {
 public static getBody(req: Request): Pick<Request, "body"> { return req.body || {}; }  // ...}

特殊注释

英文
中文
颜色、格式明显区别于其他注释

// !!! 别改这一行，这里是之前同事写的，删除会有问题this.doSomethingImportant();
// $ 我觉得这里有优化的空间，以后请考虑重写let a = 1;let b = 1;let answer = a + b;if(answer) console.log(answer);else console.log("Error!");
// TODO: XXX需要在这里加上证书校验// ...