您好,登录后才能下订单哦!
这篇文章主要介绍了C语言中注释与注意事项的示例分析,具有一定借鉴价值,感兴趣的朋友可以参考下,希望大家阅读完这篇文章之后大有收获,下面让小编带着大家一起了解一下。
注释应该出现在三种位置
文件头部
函数头部
函数体内的和代码混在一起的注释
对于文件头部的注释至少列出:
版权声明、版本号、文件创建日期、作者、内容/功能、与其他文件的关系、修改日志等。
函数头部注释要求至少列出:
函数功能、输入/输出参数、返回值、调用/被调用关系等。
注释在预编译阶段就会被删除掉,但是这里的删除并不是字面意义的删除,而是被替换,注释被替换,本质是替换成空格。
以下面的代码为例:
#include <stdio.h> int main() { int /* */ i; //正确 char *s = "abcdefgh //hijklmn"; //正确 //Is it a\ valid comment? //正确 in/* */t j; //报错 return 0; }
由于被替换成了空格,所以in t j这句话是无法编译的。
如果是C语言风格的注释出现了嵌套,则/*总是与离它最近的*/匹配,第二个/*并不会被认为是注释符号,因此第一个/*与第一个*/匹配,代码会剩下一个*/:
注释应当准确、易懂,反之有二义性。错误的注释容易产生误导,不利于代码维护。
边写代码边修改注释,修改代码的同时要修改对应的注释,保证注释和代码的一致性。不再有用的注释要及时删除。
注释是对代码的“提示”,所以注释应当简单明了,因为注释太多会让人眼花缭乱。
对于全局数据(全局变量、常量定义等)必须要加注释。注释清楚定义全局数据的目的。
注释的位置应该与被描述的代码相邻,可以与语句在同一行,也可以在语句的上一行,但不能在语句的下一行,因为这样不符合人的阅读习惯。
当代码比较长,特别是有多重嵌套时,应当在一些段落结束时加注释,便于阅读。
注释的缩进要与代码的缩进一致,这样代码会更美观,可读性强。
注释代码段时应当注重“为何做”而不是“怎么做”,要说明这段代码的操作意图。
数值的单位一定要注释。
对变量的范围给出注释,特别是参数。
对一系列的数字编号给出注释,尤其是在编写底层驱动的程序。
避免在一行代码或表达式的中间插入注释。
复杂的函数中,在分支语句、循环语句结束之后需要加注释,方便区分各分支或循环体。
感谢你能够认真阅读完这篇文章,希望小编分享的“C语言中注释与注意事项的示例分析”这篇文章对大家有帮助,同时也希望大家多多支持亿速云,关注亿速云行业资讯频道,更多相关知识等着你来学习!
免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。