LiteOS-编程规范:注释

时间：2023-11-01 16:13:31

LiteOS

注释的内容要清楚、明了，含义准确，防止注释二义性。
在代码的功能、意图层次上进行注释，即注释解释代码难以直接表达的意图，而不是仅仅重复描述代码。
函数声明处注释描述函数功能、性能及用法，包括输入和输出参数、函数返回值、可重入的要求等；定义处详细描述函数功能和实现要点，如实现的简要步骤、实现的理由、设计约束等。
全局变量要有较详细的注释，包括对其功能、取值范围以及存取时注意事项等的说明。
避免在注释中使用缩写，除非是业界通用或子系统内标准化的缩写。
文件头部要进行注释，建议注释列出：版权说明、版本号、生成日期、作者姓名、功能说明、与其它文件的关系、修改日志等。
注释风格要统一，建议优先选择/* */的方式，注释符与注释内容之间要有1空格，单行、多行注释风格如下：
```
/* 单行注释 */
```
```
/* * 多行注释 * 第二行 */
```
注释应放在其代码上方或右方。
上方的注释，与代码行之间无空行，保持与代码一样的缩进。右边的注释，与代码之间至少相隔1个空格。如果有多条右置注释，上下对齐会更加美观，比如：
```
#define A_CONST 100         // 此处两行注释属于同类#define ANOTHER_CONST 200   // 可保持左侧对齐
```