C语言的注释要注意几点
ACM比赛整理
共 1954字,需浏览 4分钟
·
2022-06-26 20:40
注释风格
//
或 /* */
,只要统一就好。//
或 /* */
都可以,但 //
更 常用,要在如何注释及注释风格上确保统一。文件注释
.h
文件声明了多个概念, 则文件注释应当对文件的内容做一个大致的说明, 同时说明各概念之间的联系. 一个一到两行的文件注释就足够了, 对于每个概念的详细文档应当放在各个概念中, 而不是文件注释中。.h
和 .cc
之间复制注释, 这样的注释偏离了注释的实际意义。函数注释
.h
文件或其他地方的函数声明处直接复制注释. 简要重述函数功能是可以的, 但注释重点要放在如何实现上。变量注释
拼音注释
TODO 注释
TODO
注释。TODO
注释要使用全大写的字符串 TODO
, 在随后的圆括号里写上你的名字, 邮件地址, bug ID, 或其它身份标识和与这一 TODO
相关的 issue. 主要目的是让添加注释的人 (也是可以请求提供更多细节的人) 可根据规范的 TODO
格式进行查找. 添加 TODO
注释并不意味着你要自己来修正, 因此当你加上带有姓名的 TODO
时, 一般都是写上自己的名字。最后
评论