注释原则

需要注释的位置

1.文件开头

2.配置文件

3.接口列表

4.路径配置

5.分块

6.步骤

7.函数

8.业务

9.数据项

10.自定义内容

11.可能产生歧义的内容

代码风格

1.精简(用简短语句实现)

2.紧凑(排版无多余东西)

3.完整(逻辑无漏洞,错误处理到位)

4.专业(不得出现中文和拼音等)

5.通用(代码可适用多场景)

6.勿滥用异常机制(禁止滥用try catch)

注释方法

名称+{规定、取值、注意事项...}+用途