当前位置:首页 > 公众号精选 > C语言编程
[导读]来源于网络没有血案,但有些冲突。不是代码bug,我要讲注释风格。这位看官,既然来了,且读且评吧。故事是真实的,如有雷同纯属巧合。故事是真实的,如有雷同纯属巧合。事情是这样的,有人离职,公司调我补缺。那个系统一直有个工程师在维护,参与该系统的新人来了又走,他始终泰然自若。刚过去一个...

来源于网络
没有血案,但有些冲突。不是代码bug,我要讲注释风格。


这位看官,既然来了,且读且评吧。故事是真实的,如有雷同纯属巧合。

故事是真实的,如有雷同纯属巧合。

事情是这样的,有人离职,公司调我补缺。那个系统一直有个工程师在维护,参与该系统的新人来了又走,他始终泰然自若。刚过去一个礼拜,我就心下窃吼:“坑爹啊!”,也彻底体会到什么叫---绝对的权威、专家。该软件系统,是公司发家的支柱产品,涉及十几个国家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”是一个如此的醒目,很容易成为一个评估软件质量、工作绩效的搜索关键词。从管理的角度,这个是可以量化的。因此,

理由三: 使用/**/注释代码,有利于公司进行软件质量控管,对程序员绩效考核。

版权申明:内容来源网络,版权归原创者所有。除非无法确认,我们都会标明作者及出处,如有侵权烦请告知,我们会立即删除并表示歉意。谢谢!


本站声明: 本文章由作者或相关机构授权发布,目的在于传递更多信息,并不代表本站赞同其观点,本站亦不保证或承诺内容真实性等。需要转载请联系该专栏作者,如若文章内容侵犯您的权益,请及时联系本站删除。
换一批
延伸阅读

9月2日消息,不造车的华为或将催生出更大的独角兽公司,随着阿维塔和赛力斯的入局,华为引望愈发显得引人瞩目。

关键字: 阿维塔 塞力斯 华为

加利福尼亚州圣克拉拉县2024年8月30日 /美通社/ -- 数字化转型技术解决方案公司Trianz今天宣布,该公司与Amazon Web Services (AWS)签订了...

关键字: AWS AN BSP 数字化

伦敦2024年8月29日 /美通社/ -- 英国汽车技术公司SODA.Auto推出其旗舰产品SODA V,这是全球首款涵盖汽车工程师从创意到认证的所有需求的工具,可用于创建软件定义汽车。 SODA V工具的开发耗时1.5...

关键字: 汽车 人工智能 智能驱动 BSP

北京2024年8月28日 /美通社/ -- 越来越多用户希望企业业务能7×24不间断运行,同时企业却面临越来越多业务中断的风险,如企业系统复杂性的增加,频繁的功能更新和发布等。如何确保业务连续性,提升韧性,成...

关键字: 亚马逊 解密 控制平面 BSP

8月30日消息,据媒体报道,腾讯和网易近期正在缩减他们对日本游戏市场的投资。

关键字: 腾讯 编码器 CPU

8月28日消息,今天上午,2024中国国际大数据产业博览会开幕式在贵阳举行,华为董事、质量流程IT总裁陶景文发表了演讲。

关键字: 华为 12nm EDA 半导体

8月28日消息,在2024中国国际大数据产业博览会上,华为常务董事、华为云CEO张平安发表演讲称,数字世界的话语权最终是由生态的繁荣决定的。

关键字: 华为 12nm 手机 卫星通信

要点: 有效应对环境变化,经营业绩稳中有升 落实提质增效举措,毛利润率延续升势 战略布局成效显著,战新业务引领增长 以科技创新为引领,提升企业核心竞争力 坚持高质量发展策略,塑强核心竞争优势...

关键字: 通信 BSP 电信运营商 数字经济

北京2024年8月27日 /美通社/ -- 8月21日,由中央广播电视总台与中国电影电视技术学会联合牵头组建的NVI技术创新联盟在BIRTV2024超高清全产业链发展研讨会上宣布正式成立。 活动现场 NVI技术创新联...

关键字: VI 传输协议 音频 BSP

北京2024年8月27日 /美通社/ -- 在8月23日举办的2024年长三角生态绿色一体化发展示范区联合招商会上,软通动力信息技术(集团)股份有限公司(以下简称"软通动力")与长三角投资(上海)有限...

关键字: BSP 信息技术
关闭
关闭