
C语言中的注释
发布日期:2021-05-07 16:45:30
浏览次数:29
分类:精选文章
本文共 1421 字,大约阅读时间需要 4 分钟。
C语言中的注释注释方法有两种:
- /* / 块注释 2. // 行注释 以下有几个例子:(1)int/…/i; (2)char s=“abcdefgh //hijklmn”; (3) //Is it a\ (4) in/…/t i; 那这前3个都是正确的注释,而(4)是错误的 (1)编译器在处理代码时,会将注释用空格替换,而不是简单地剔除,所以这一行代码去掉注释后是int i,而不是inti,所以此处注释是正确的。 (2)我们知道双引号引起来的都是字符串常量,那双斜杠也不例外 (3)这一条也是合法的,因为\是一个接续符。 (4)由(1)的解释可知这条注释是错误的 以上可以总结出一句话:C语言的注释是不能出现在代码的任何位置。 使用/**/有两点需要注意: (1)/…/不能嵌套使用,因为/总是和最近的一个/相结合 (2)/和之间没有空格,所以在代码中出现/,编译器就会认为是注释的开始。 eg:y = x/*p y = x/*p,这是表示 x 除以 p 指向的内存里的值,把结果赋值为 y?我们可以在编译器上测试一下,编译器提示出错。 实际上,编译器把/*当作是一段注释的开始,把/后面的内容都当作注释内容,直到出现/为止。这个表达式其实只是表示把 x 的值赋给y,/后面的内容都当作注释。但是,由于没有找到/,所以提示出错。我们可以把上面的表达式修改一下:y = x/ *p或者y = x/(p)这样的话,表达式的意思就是 x 除以 p 指向的内存里的值,把结果赋值为 y 了。 出色注释的基本要求: 【规则 1】注释应当准确、易懂,防止有二义性。错误的注释不但无益反而有害。 【规则 2】边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要及时删除。 【规则 3】注释是对代码的“提示”,而不是文档。程序中的注释应当简单明了,注释太多了会让人眼花缭乱。 【规则 4】一目了然的语句不加注释。例如:i++; / i 加 1 */多余的注释 【规则 5】对于全局数据(全局变量、常量定义等)必须要加注释。 【规则 6】注释采用英文,尽量避免在注释中使用缩写,特别是不常用缩写。因为不一定所有的编译器都能显示中文,别人打开你的代码,你的注释也许是一团乱码。还有,你的代码不一定是懂中文的人阅读。 【规则7】注释的位置应与被描述的代码相邻,可以与语句在同一行,也可以在上行,但不可放在下方。同一结构中不同域的注释要对齐。 【规则 8】当代码比较长,特别是有多重嵌套时,应当在一些段落的结束处加注释,便于阅读。 【规则 9】注释的缩进要与代码的缩进一致。 【规则10】注释代码段时应注重“为何做(why)”,而不是“怎么做(how)”。说明怎么做的注释一般停留在编程语言的层次,而不是为了说明问题。尽力阐述“怎么做”的注释一般没有告诉我们操作的意图,而指明“怎么做”的注释通常是冗余的。 【规则 11】数值的单位一定要注释。注释应该说明某数值的单位到底是什么意思。比如:关于长度的必须说明单位是毫米,米,还是千米等;关于时间的必须说明单位是时,分,秒,还是毫秒等。 【规则 12】对变量的范围给出注释。 【规则 13】对一系列的数字编号给出注释,尤其在编写底层驱动程序的时候(比如管脚编号)。 【规则14】对于函数的入口出口数据给出注释。 以上规则是在一本书中看到的,我觉得总结的很全面,所以拿来跟大家分享。
发表评论
最新留言
哈哈,博客排版真的漂亮呢~
[***.90.31.176]2025年04月07日 22时39分41秒
关于作者

喝酒易醉,品茶养心,人生如梦,品茶悟道,何以解忧?唯有杜康!
-- 愿君每日到此一游!
推荐文章
文件上传-FileUpload
2021-05-08
快速排序
2021-05-08
Pyinstaller打包的exe文件过大的解决方法
2021-05-08
Linux的软链接跟Windows快捷方式一样?
2021-05-08
更改github的默认语言类型
2021-05-08
使用bigdecima实例化时传int和string时的精度丢失
2021-05-08
使用第三方sdk,微信wechat扫码登录
2021-05-08
mysql中的行转列
2021-05-08
java8中的闭包Function/BiFunction
2021-05-08
flink —— checkpoint机制
2021-05-08
shell脚本中冒泡排序、直接排序、反转排序
2021-05-08
WPS及Excel中Alt键的妙用 快捷键
2021-05-08
C - 食物链 并查集
2021-05-08
Pycharm 常用快捷键
2021-05-08
基于Altium Designer的电子设计的入门指南
2021-05-08
基于LabVIEW的入门指南
2021-05-08
PCB布局系列汇总
2021-05-08
电阻入门知识
2021-05-08