C语言代码注释必须用/**/ , 你没看错~
事情是这样的,有人离职,公司调我补缺。那个系统一直有个工程师在维护,参与该系统的新人来了又走,他始终泰然自若。刚过去一个礼拜,我就心下窃吼:“坑爹啊!”,也彻底体会到什么叫---绝对的权威、专家。该软件系统,是公司发家的支柱产品,涉及十几个国家x七八个机型,700 个文件 (C语言,所有.c .h档),十几万行代码,尽两百个跨模块全局变量,编译条件成百上千......(好吧,这是找借口、吐槽的节奏)。
尽管有名义上的交接,和几次和声细语的密切指导。但真正独立展开工作时,许多小功能增删改,我都要折腾个好几天才能厘清代码调用关系、算法原 理,然后找到修改点谨慎细微龟速前行。
进度追踪的人有的时候也催毛了,直接请专家大师出手,咔咔咔,不到半天就搞定了。当然,前期我当然尽量的”不耻上 问”,但人嘛,总是有遇到被激发“骨气”的时候。
这几天,好不容易搞好一个全新的功能模块,把代码推送给他合并编译。不曾想,出现了让我泣血的一幕。
我眼睁睁地、眼睁睁看着她把我辛苦敲入的代码注释/**/通通换成//,一份精美的代码,顿时成渣。
我询问缘由,她的回答是: 当代码里面充满注释符号/**/时,她想要用/**/注释整段代码时,就会很麻烦。
我理解了,因为/**/不支持嵌套。比如下面这样的语句是编译不过的。
1 /*
2 a = b c; /* 注释 */
3 */
4
我的手抬了抬,终究作罢。虽然我感觉到尊严被践踏,心爱的作品被蹂躏,但我还是开始反思。
许多软件规范、专家、有经验的工程,都建议或要求注释代码最好使用/**/,他们的理由大略如下:
1
"//"进行注释不够严谨
例如:
1 // 注释语句 ??/
2a = b c;
此时,a = b c在一些编译器不会被执行。
因为"??/"会被编译器当作 \,变成C语言的换行符。于是这段代码等同于// 注释语句 a = b c ;就会被注释掉。大家有兴趣的,不妨去搜索一下"C语言 三字母词"
当然,哪怕没有??/, 自己打盹碰到delete键也是会屏蔽掉a=b c的。
2
"//"的注释来源于C
有些早期的C编译器对这种注释是不支持的。代码要做到全平台兼容,这点是必须要考虑的。
因此,老外定义的C语言软件规范,无论是MISRA还是CMMI,一般都要求所有代码注释必须使用/**/。
君不见,那uCOS的最新版本源码,所有注释都是/**/。
君不见,那STM32的最新固件库,洋洋洒洒几十个文件,通篇皆没有用到//。
正是基于这样的理由,让我的心中充满了愠怒。但我仍然没有当场反驳她,因为这些理由还有些苍白无力。
1、当时,那个什么三字母词“??x”到底是什么我已经忘了,没法立刻做试验编译给她看,而且时候我里面做了编译实验,得到的是:
"filename.c", line xxxx: Warning: #2532-D: support for trigraphs is disabled xx代码语句xx // ??/
trigraph金山词霸---> [traigra:f]三字母词,看吧,编译器都警告了,默认是不支持的。
2、而且,所谓的//是C 的,早期的c编译器不支持。
这点谁鸟啊,我们只要现在,只用最新版本的编译器,所以,我还要继续思考,我要维护这个传统,为自己代言......
我开始思考,还有什么强劲有力的理由,来支持我恪守的真理:C语言代码注释必须使用/**/。
3
我的三大理解
倘若所有代码里面的注释用到/**/时,当你要注释掉这段代码时,如果不想忍受编译器的嵌套报警,又懒得把一个个/**/换成//的话。那么你还有如下选择。
1) 慎重思考下是否删光这段代码,如果还有些不舍,那就先"备份"(git推送)一下再删光。因此,
理由一:使用/**/注释代码,会使软件系统减少冗余的僵尸代码,鼓励程序员的程序备份行为。
2) 或者用编译条件圈起来,如下。
1#if (XXX_ENABLE)
2 func(a, b, c); /* 注释 */
3 ...... /* 注释 */
4#endif
那么你不得不考虑xxx的命名,如何更加一目了然,再写点注释什么的,表明对这段代码“弃而不舍”的缘由。因此,
理由二:使用/**/注释代码,会鼓励程序员删除代码时,三思而后行,并且注明舍弃的理由。
3) 当然,偷懒的人还是会用 #if 0 #endif圈起来, 如下,
1#if 0
2 func(a, b, c); /* 注释 */
3 ...... /* 注释 */
4#endif
而且不会写任何注释表明删除的理由。然而,“#if 0”是一个如此的醒目,很容易成为一个评估软件质量、工作绩效的搜索关键词。从管理的角度,这个是可以量化的。因此,
理由三: 使用/**/注释代码,有利于公司进行软件质量控管,对程序员绩效考核。
这三个理由,足够说服你么?
声明:
本文于网络整理,版权归原作者所有,如来源信息有误或侵犯权益,请联系我们删除或授权事宜。
C语言代码注释必须用/**/ , 你没看错~相关推荐
- C语言代码注释 - C语言零基础入门教程
目录 方法一:使用// 方法二:使用/* */ 方法三:使用宏 #if #else #end 猜你喜欢 零基础 C/C++ 学习路线推荐 : C/C++ 学习目录 >> C 语言基础入门 ...
- 大数据分析苏轼,你没看错,这些都是小学生完成的
适逢苏轼先生诞辰980周年,清华附小开展了一系列致敬苏轼的活动.同学们利用假期时间共完成课题研究报告23份:<大数据帮你进一步认识苏轼>.<苏轼的朋友圈>.<苏轼的旅游品 ...
- 32岁了 学python 来的及吗-32岁的程序员去了国企工作, 晒出年薪, 网友: 我没看错吧...
原标题:32岁的程序员去了国企工作, 晒出年薪, 网友: 我没看错吧 现如今,相信很多朋友都非常羡慕那些互联网大公司的从业人员,因为他们动不动就年薪三四十万以上,但是这些互联网行业的从业人员也有自己的 ...
- android手机怎么拍月亮,用手机拍月亮!对,你没看错
用手机拍月亮!对,你没看错 2020-01-12 20:54:00 0点赞 3收藏 4评论 12月16日,vivo在桂林发布了全新的X系列影像旗舰手机,vivo X30 Pro .拍照硬件方面,这台手 ...
- 你没看错,浩辰3D软件中CAD图纸与3D模型高效转化这么好用!
3D模型精度低,无法有效利用? 零件设计很复杂,手忙脚乱.效率低? 各类CAD图纸,都要一笔一画来绘制? 每次设计修改,都仿佛是渡劫修仙, 熬夜加班,咖啡续命? 是时候,改变这一切了! 你没看错,浩辰 ...
- 这段c语言代码牛逼在哪?看得我一脸懵逼!
有人说C语言是世界上最牛逼的语言,因为操作系统就是用C语言编写的,学好了C才能更好的学习其他编程语言.为此,有人分享了下面一段代码,说是很牛逼的c语言代码,看得小编一脸懵逼.大家来看看,它究竟牛在哪里 ...
- c++ doxygen 注释规范_C语言代码注释参考
简述 该参考是基于Doxygen注释规范进行简单归纳,可以适当根据自己的需求进行约定. Doxygen可以从一套归档源文件开始,生成HTML格式的在线类浏览器,或离线的LATEX.RTF参考手册.简单 ...
- swoole 异步client redis TP5 微信模板消息 demo版本比较杂 代码注释啥的都没删除 但是可以用作为参考
tplmsg 发送模板消息的类 <?php namespace app\admin\controller; use app\admin\controller\Base; use think\C ...
- python骂人代码大全_求助:没看懂其中一段代码的意思
该楼层疑似违规已被系统折叠 隐藏此楼查看此楼 在笨方法学python中有一段代码如下: def cheese_and_crackers(cheese_count, boxes_of_crackers) ...
最新文章
- java 正则 cpu 100_这六个原因真的可以使Java应用程序的CPU使用率飙升到100%吗?...
- spring初始化web_了解Spring Web初始化
- 自由自在休闲食品带给小资的冰淇淋生活
- hadoop配置后无法通过主机名:50070访问,只能通过ip:50070访问
- python求函数极值_python 遗传算法求函数极值的实现代码
- Gradle多项目构建–类似父pom的结构
- 【FZU - 1759】Super A^B mod C (数论,快速幂,快速乘,欧拉降幂,指数循环节,模板)
- 面趣 | 那些面试没过的程序员,都去了哪里?答案真的挺励志
- 齐次常系数递推关系式
- Net作业调度(二) -CrystalQuartz远程管理
- Eclipse利用正则表达式快速去掉注释的方法
- var radioname = new array();_兰帕德:引进VAR是为了回放关键时刻的情况,他们的行为令我困惑...
- 将markdown格式转化为bootstrap风格html
- Python Window10 环境安装流程
- 生成CFree 5.0 注册码
- uptool u盘量产工具 v2.093
- UE5 IK重定向并修改人物姿势
- 论文阅读 Learning Motion in Feature Space: Locally-Consistent Deformable Convolution Networks
- c语言中输出姓名身高,c语言输出身高:男生身高=(爸身高+妈身高)×0.54 女生身高=(爸身高×0.92+妈身高)÷2...
- QChart之QBarSeries绘制条形图
热门文章
- 从Commons CLI迁移到picocli
- tomcat 正常关闭_Tomcat的带有守护程序和关闭钩子的正常关闭
- 使用Java Servlet,JSP标签和Stormpath快速构建Java Web App
- 如何掌握Java内存(并保存程序)
- spring jmx_JMX和Spring –第2部分
- Oracle Spring Clean JavaFX应该吗?
- maven 构建依赖树_Maven构建依赖项
- Spring 4.1和Java 8:java.util.Optional
- 风暴事件处理器–每个工作者的GC日志文件
- Java:本地最小语言