[导读]来源于网络没有血案,但有些冲突。不是代码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 02 func(a, b, c);
/* 注释 */3 ......
/* 注释 */4#endif
而且不会写任何注释表明删除的理由。然而,“#if 0”是一个如此的醒目,很容易成为一个评估软件质量、工作绩效的搜索关键词。从管理的角度,这个是可以量化的。因此,理由三: 使用/**/注释代码,有利于公司进行软件质量控管,对程序员绩效考核。版权申明:内容来源网络,版权归原创者所有。除非无法确认,我们都会标明作者及出处,如有侵权烦请告知,我们会立即删除并表示歉意。谢谢!
本站声明: 本文章由作者或相关机构授权发布,目的在于传递更多信息,并不代表本站赞同其观点,本站亦不保证或承诺内容真实性等。需要转载请联系该专栏作者,如若文章内容侵犯您的权益,请及时联系本站删除。
京元电子在重大讯息说明会中宣布,将出售持有苏州子公司京隆科技 92.1619% 的股权,预估交易金额约 48.85 亿人民币,将于第三季度完成交易,届时将退出中国大陆半导体制造业务。
关键字:
半导体制造
半导体封测
封装测试
京元电子
业内消息,近日台积电在北美技术研讨会上宣布,正在研发 CoWoS 封装技术的下个版本,可以让系统级封装(SiP)尺寸增大两倍以上,实现 120x120mm 的超大封装,功耗可以达到千瓦级别。
关键字:
CoWoS
台积电
封装
据外媒报道,字节正在内部探索出售TikTok美国业务多数股权,并援引内部人士披露的信息称 “沃尔玛或为最理想买家”。报道还称,讨论中的一种情况是字节出售美国50%以上TikTok股份,但保留少数股权。
关键字:
字节跳动
TikTok
业内消息,HMD 正在计划重启一些经典的诺基亚功能手机。今年 3 月初,该公司预告了将于 5 月发布的一款功能手机。现在该机的身份已经曝光,新款诺基亚 3210 的谍照已经泄露,展现了新机部分新特性。
关键字:
诺基亚
功能机
HMD
业内消息,近日有一位网友在各大社交媒体发文表示,自己离职后,公司将自己所有的期权全部作废。
关键字:
期权
微博
业内消息,在昨天的中关村论坛未来人工智能先锋论坛上,生数科技联合清华大学正式发布中国首个长时长、高一致性、高动态性视频大模型——Vidu。Vidu是自Sora发布之后全球率先取得重大突破的视频大模型,性能全面对标Sora...
关键字:
Sora
清华
AI
Vidu
近日,台积电在圣克拉拉年度技术研讨会上宣布首个“埃级”制程技术:A16。A16 是台积电首次引入背面电源输送网络技术,计划于 2026 年下半年开始量产。同时,台积电也在重新命名工艺节点,标志着「埃级」时代的开始。
关键字:
台积电
A16
4 月 25 日消息,4 月 25 日,国际数据公司(IDC)发布 2024 年第一季度中国手机市场跟踪报告,荣耀以 17.1% 的市场份额拿下第一,华为占 17.0% 位列第二,OPPO、苹果和 vivo 分别位列第三...
关键字:
荣耀
华为
业内消息, 近日华为全新Pura 70系列手机正式开售引发广大 数码爱好者追捧,但是有网友注意到这款手机的“AI修图”功能,竟然可以将照片中的人物衣服消除,并拍成视频发布网络。
关键字:
华为Pura70
华为
据韩媒报道,近日韩国多位军方人士透露,韩国军方正在考虑全面禁止在军事建筑内使用苹果手机,军方担心敏感信息通过录音泄露。
关键字:
iPhone
苹果
据韩媒《朝鲜日报》消息,三星集团已确认已决定将适用于三星电子等部分关联公司的“高管每周工作 6 天”扩大到整个集团。三星子公司的人力资源团队直接通过口头、群聊和电子邮件向高管传达了这一新政,而非正式信函的形式。
关键字:
三星
4月23日,深圳传音控股股份有限公司发表了2023年年度报告。数据显示,2023年,该公司手机整体出货量约1.94亿部。
关键字:
传音
智能手机
最新消息,美国参议院以 79 票赞成、18 票反对的压倒性多数,通过了一项可能导致 TikTok 在美国被禁的法案,该法案要求字节跳动公司出售 TikTok,否则将面临禁令。TikTok 最多有 12 个月的时间从母公司...
关键字:
美国
TikTok
字节跳动
业内消息,近日数码博主@手机晶片达人在社交媒体发文表示,苹果公司正在研发自家的 AI 服务器芯片,采用台积电的 3nm 工艺,预估将于 2025 年下半年量产。台积电是苹果最重要的合作伙伴,目前苹果的大部分 3nm 产能...
关键字:
苹果
AI服务器芯片
台积电
3nm
业内消息,近日苹果公司公布了2023财年供应链名单。其中,中国大陆地区新进8家企业,有4家企业被剔除;中国台湾地区供应商新进2家企业,同样有4家企业被剔除。
关键字:
苹果
供应链
业内消息,上周第 21 届华为分析师大会在深圳开幕,大会期间华为云核心网产品线总裁高治国表示,华为携手浙江移动完成了全球首个 5G-A(5.5G)核心网智能差异化体验保障方案的预商用部署。
关键字:
华为
5.5G
业内消息,上周国务院新闻发布会介绍了2024年一季度工业和信息化发展情况。工业和信息化部新闻发言人、总工程师赵志国在发布会上表示,一季度中国 5G 手机出货量达 5643 万部,同期占比 83.7%,反映出高端或者智能...
关键字:
工信部
手机
业内消息,近日供应链大厂群光电子(Chicony Electronics)在官网披露报告声称于 4 月 15 日遭到黑客组织 Hunters International 攻击,据称超过 1.2TB 内部数据(共计 414...
关键字:
供应链
群光电子
黑客入侵