尽量少写注释
需有必要性和确定性
单行注释如下,注意空格
/* this is a single line comment */
多行注释如下,注意对齐
/*
* this is a multiline comment
* this is the second line
*/
注释之前若为同级代码,则有一个空行
注释之后没有空行
行尾如需注释,尽量使用单行注释
相同成员的行尾注释要对齐
行尾如需多行注释,其第一行不用为空
函数头注释包含功能描述、入参、返回值等
如果宏当作函数使用,使用与函数类似的注释
不使用嵌套注释
不使用双斜线注释
可使用宏开关代替注释,尤其是多行注释
void test(int data)
{
#if 0
if(data < 0)
{
printf("data=%d\n", data);
}
#endif
printf("data=%u\n", data);
return;
}