代码注释该怎么写才规范?
来源:strongerHuang 发布时间:2024-05-06 分享至微信
注释风格
//
或/**/
,只要统一就好。//
或/**/
都可以,但//
更常用,要在如何注释及注释风格上确保统一。文件注释
.h
文件声明了多个概念, 则文件注释应当对文件的内容做一个大致的说明, 同时说明各概念之间的联系. 一个一到两行的文件注释就足够了, 对于每个概念的详细文档应当放在各个概念中, 而不是文件注释中。.h
和.cc
之间复制注释, 这样的注释偏离了注释的实际意义。函数注释
.h
文件或其他地方的函数声明处直接复制注释. 简要重述函数功能是可以的, 但注释重点要放在如何实现上。变量注释
拼音注释
TODO 注释
TODO
注释。TODO
注释要使用全大写的字符串TODO
, 在随后的圆括号里写上你的名字, 邮件地址, bug ID, 或其它身份标识和与这一TODO
相关的 issue. 主要目的是让添加注释的人 (也是可以请求提供更多细节的人) 可根据规范的TODO
格式进行查找. 添加TODO
注释并不意味着你要自己来修正, 因此当你加上带有姓名的TODO
时, 一般都是写上自己的名字。最后
[ 新闻来源:strongerHuang,更多精彩资讯请下载icspec App。如对本稿件有异议,请联系微信客服specltkj]
存入云盘 收藏
举报
全部评论
暂无评论哦,快来评论一下吧!
strongerHuang
作者黄工,高级嵌入式软件工程师,CSDN博客专家,嵌入式领域知名号,专注分享嵌入式软硬件、AIoT(物联网+人工智能)、单片机、通信技术、开发工具、半导体、行业资讯等相关内容。
查看更多
相关文章
会写stm32的代码,但在公司被分配到了做杰里芯片,连点灯都不会了,怎么办?
2024-04-19
2023年代码输出总结
2024-04-26
Linux掌握到什么程度才算精通?
2024-05-11
如何编写可读性高的 C 代码?
2024-04-01
英国起草AI规范,Sunak倡创新审慎监管
2024-04-17
热门搜索