标签：11 语句 右方 上方 16 代码 规范 注释 放在

1.有效注释量必须在20%以上，注释语言要准确易懂简洁 2.头文件应进行注释，注释必须列出：版本说明、版本号、生成日期、作者、内容、功能、修改日志等。 3.函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值、调用关系（函数、表）等。 4.编写代码边注释，修改代码的同时，修改对应的注释，保证注释与代码的一致性。没用的注释删除 5.注释内容要准确明了，不能有歧义 6.不要再注释中使用只有你自己看的懂得缩写 7.单行代码的注释要放在单行代码的上方或右方，放在上方时要与上一个语句空行隔开 8.变量、常量、宏的注释都应放在其上方或右方 9.数据结构的注释放在其上方，成员的注释放在其右方 10.全局变量要有详细的注释，包括其功能、取值范围、函数调用等（反正我自己没有标注那么多） 11.不要在代码或表达式中插入注释 12.代码注释注意格式，不要乱，影响代码观感。注释最好与所描述的代码同样的缩排，可使程序排版整齐，方便阅读理解。格式统一:/* ……     ……*/ 13.注释有用的信息，没用的信息不要注释 14.对变量的定义和分支语句（条件分支、循环语句等）必须编写注释 15.switch中的case语句最好注释一下 16.语言建议使用中文，除非你的英语水平很高，表达的非常清楚        ------参考《C语言精彩例程200例》

标签：11,语句,右方,上方,16,代码,规范,注释,放在
来源： https://www.cnblogs.com/epll/p/11874141.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。