C语言编码“注释”规范
ACM比赛整理
共 2134字,需浏览 5分钟
· 2022-04-16
注释风格
1、总述
一般使用 //
或 /* */
,只要统一就好。
2、说明
//
或 /* */
都可以,但 //
更 常用,要在如何注释及注释风格上确保统一。
文件注释
1、总述
如果一个 .h
文件声明了多个概念, 则文件注释应当对文件的内容做一个大致的说明, 同时说明各概念之间的联系. 一个一到两行的文件注释就足够了, 对于每个概念的详细文档应当放在各个概念中, 而不是文件注释中。
不要在 .h
和 .cc
之间复制注释, 这样的注释偏离了注释的实际意义。
函数注释
1、总述
不要 从 .h
文件或其他地方的函数声明处直接复制注释. 简要重述函数功能是可以的, 但注释重点要放在如何实现上。
变量注释
1、总述
拼写注释
1、总述
TODO 注释
1、总述
TODO
注释。TODO
注释要使用全大写的字符串 TODO
, 在随后的圆括号里写上你的名字, 邮件地址, bug ID, 或其它身份标识和与这一 TODO
相关的 issue. 主要目的是让添加注释的人 (也是可以请求提供更多细节的人) 可根据规范的 TODO
格式进行查找. 添加 TODO
注释并不意味着你要自己来修正, 因此当你加上带有姓名的 TODO
时, 一般都是写上自己的名字。TODO 注释
1、总述
DEPRECATED
comments)以标记某接口点已弃用.DEPRECATED
的注释, 以标记某接口为弃用状态. 注释可以放在接口声明前, 或者同一行.DEPRECATED
一词后, 在括号中留下您的名字, 邮箱地址以及其他身份标识.DEPRECATED
并不会让大家不约而同地弃用, 您还得亲自主动修正调用点(callsites), 或是找个帮手.结语
注释固然很重要, 但最好的代码应当本身就是文档,有意义的类型名和变量名, 要远胜过要用注释解释的含糊不清的名字。
你写的注释是给代码阅读者看的, 也就是下一个需要理解你代码的人. 所以慷慨些吧, 下一个读者可能就是你!
版权申明:内容来源网络,版权归原创者所有。除非无法确认,都会标明作者及出处,如有侵权,烦请告知,我们会立即删除并致歉!
评论
大厂都在用的 Git 代码管理规范 !
👉 欢迎加入小哈的星球 ,你将获得: 专属的项目实战 / Java 学习路线 / 一对一提问 / 学习打卡 / 赠书福利全栈前后端分离博客项目 2.0 版本完结啦, 演示链接:http://116.62.199.48/ ,新项目正在酝酿中
小哈学Java
2
PyPy为什么能让Python比C还快?一文了解内在机制
我的小册:(小白零基础用Python量化股票分析小册) ,原价299,限时特价2杯咖啡,满100人涨10元。来源:机器之心「如果想让代码运行得更快,您应该使用 PyPy。」—— Python 之父 Guido van Rossum对于研究人员来说,迅速把想法代码化并查看其是否行得通至关重要。Pyth
菜鸟学Python
0
免费AI编程助手,支持Visual Studio,让编码愉悦又轻松
前言前有Copilot各种酷炫操作,今有国产软件杀出重围。给大家介绍的是一款国内的国产编程神器,可与微软GitHub Copilot比比身手。关键它还是完全免费。它就是:非十团队国产自主研发的Fitten Code。此工具的速度是GitHub Copilot的两倍,同时它的精确度还有大约2
dotNET全栈开发
10
C语言基础之动态内存操作汇总
来源:机器之心1、堆区空间申请#include <stdlib.h> //头文件void *malloc(size_t size);//函数size表示申请的空间字节数函数的返回值:成功:返回值空间起始地址失败:NULL特点:分配指定大小的内存空间;分配的内存空间是连续的;需要手动释放
良许Linux
0
为啥我敢说Python是数据分析界的扛把子语言?
首先声明下这篇文字不是卖课的,也不是无脑吹Python,咱只讲事实,认认真真讨论下Python是不是数据分析领域最好的语言。因为我在知乎上看到非常多人在问这个问题,想必大家是关心的。我的观点是,目前来看所有编程语言里,做数据分析Python是最好的选择,没有之一。列举几个事实:1、Kaggle、天池
Python大数据分析
9
Nat. Commun. | gLM:基于宏基因组预训练语言模型的基因和蛋白调控及功能预测算法
2024年4月3日,Peter R. Girguis、Sergey Ovchinnikov、Yunha Hwang、Andre L. Cornman和Elizabeth H. Kellogg几人在Nature Communications上发表了一篇题为“Genomic language model
生信宝典
0
2024 年 4 月的编程语言排行榜,PHP历史最低!
转自:OSC开源社区TIOBE 公布了 2024 年 4 月的编程语言排行榜。世界上最好的语言——PHP 登上本月的头条 ( Is PHP losing its mojo?),但上榜却是因为其排名跌至历史最低。下图是 TIOBE 4 月 TOP 20 编程语言:可以看到,PHP 本月在 T
dotNET全栈开发
10
嵌入式C代码调试利器——backtrace
1backtrace基本原理大家好,我是bug菌~backtrace英译为回溯的意思,这听起来有点专业了,其实大部分搞嵌入式的朋友都有听说过函数调用栈callstack。而backtrace说白了就是我们呈现函数调用关系的一项功能。所以backtrace调试功能的实现原理基于函数调用栈的概念。那什么
嵌入式Linux
10