0
  • 聊天消息
  • 系统消息
  • 评论与回复
登录后你可以
  • 下载海量资料
  • 学习在线课程
  • 观看技术视频
  • 写文章/发帖/加入社区
会员中心
创作中心

完善资料让更多小伙伴认识你,还能领取20积分哦,立即完善>

3天内不再提示

C语言为何用/* */ 注释?

STM32嵌入式开发 来源:STM32嵌入式开发 2023-11-13 12:33 次阅读

事情是这样的,有人离职,公司调我补缺。那个系统一直有个工程师在维护,参与该系统的新人来了又走,他始终泰然自若。刚过去一个礼拜,我就心下窃吼:“坑爹啊!”,也彻底体会到什么叫---绝对的权威、专家。该软件系统,是公司发家的支柱产品,涉及十几个国家x七八个机型,700+个文件(C语言,所有.c .h档),十几万行代码,尽两百个跨模块全局变量,编译条件成百上千。..。..(好吧,这是找借口、吐槽的节奏)。 尽管有名义上的交接,和几次和声细语的密切指导。但真正独立展开工作时,许多小功能增删改,我都要折腾个好几天才能厘清代码调用关系、算法原理,然后找到修改点谨慎细微龟速前行。 进度追踪的人有的时候也催毛了,直接请专家大师出手,咔咔咔,不到半天就搞定了。

当然,前期我当然尽量的”不耻上问”,但人嘛,总是有遇到被激发“骨气”的时候。 这几天,好不容易搞好一个全新的功能模块,把代码推送给他合并编译。不曾想,出现了让我泣血的一幕。 我眼睁睁地、眼睁睁看着她把我辛苦敲入的代码注释/**/通通换成//,一份精美的代码,顿时成渣。 我询问缘由,她的回答是: 当代码里面充满注释符号/**/时,她想要用/**/注释整段代码时,就会很麻烦。 我理解了,因为/**/不支持嵌套。比如下面这样的语句是编译不过的。

/*

a = b+c; /* 注释 */

*/

我的手抬了抬,终究作罢。虽然我感觉到尊严被践踏,心爱的作品被蹂躏,但我还是开始反思。 许多软件规范、专家、有经验的工程,都建议或要求注释代码最好使用/**/,他们的理由大略如下:

1 “//”进行注释不够严谨

例如:

// 注释语句 ??/

a = b+c;

此时,a = b+c在一些编译器不会被执行。 因为“??/”会被编译器当作 ,变成C语言的换行符。于是这段代码等同于// 注释语句 a = b+c ;就会被注释掉。大家有兴趣的,不妨去搜索一下“C语言 三字母词” 当然,哪怕没有??/, 自己打盹碰到delete键也是会屏蔽掉a=b+c的。

2 “//”的注释来源于C++

有些早期的C编译器对这种注释是不支持的。代码要做到全平台兼容,这点是必须要考虑的。 因此,老外定义的C语言软件规范,无论是MISRA还是CMMI,一般都要求所有代码注释必须使用/**/。 君不见,那uCOS最新版本源码,所有注释都是/**/。 君不见,那STM32最新固件库,洋洋洒洒几十个文件,通篇皆没有用到//。 正是基于这样的理由,让我的心中充满了愠怒。但我仍然没有当场反驳她,因为这些理由还有些苍白无力。 当时,那个什么三字母词“??x”到底是什么我已经忘了,没法立刻做试验编译给她看,而且时候我里面做了编译实验,得到的是: “filename.c”, line xxxx: Warning: #2532-D: support for trigraphs is disabled xx代码语句xx // ??/ trigraph金山词霸---》 [traigra:f]三字母词,看吧,编译器都警告了,默认是不支持的。 而且,所谓的//是C++的,早期的c编译器不支持。 这点谁鸟啊,我们只要现在,只用最新版本的编译器,所以,我还要继续思考,我要维护这个传统,为自己代言。..。.. 我开始思考,还有什么强劲有力的理由,来支持我恪守的真理:C语言代码注释必须使用/**/。

3 我的三大理解

倘若所有代码里面的注释用到/**/时,当你要注释掉这段代码时,如果不想忍受编译器的嵌套报警,又懒得把一个个/**/换成//的话。那么你还有如下选择。 1) 慎重思考下是否删光这段代码,如果还有些不舍,那就先“备份”(git推送)一下再删光。因此, 理由一:使用/**/注释代码,会使软件系统减少冗余的僵尸代码,鼓励程序员的程序备份行为。 2) 或者用编译条件圈起来,如下。

#if (XXX_ENABLE)

func(a, b, c); /* 注释 */

。..。.. /* 注释 */

#endif

那么你不得不考虑xxx的命名,如何更加一目了然,再写点注释什么的,表明对这段代码“弃而不舍”的缘由。因此, 理由二:使用/**/注释代码,会鼓励程序员删除代码时,三思而后行,并且注明舍弃的理由。 3) 当然,偷懒的人还是会用 #if 0 #endif圈起来, 如下,

#if 0

func(a, b, c); /* 注释 */

。..。.. /* 注释 */

#endif

而且不会写任何注释表明删除的理由。然而,“#if 0”是一个如此的醒目,很容易成为一个评估软件质量、工作绩效的搜索关键词。从管理的角度,这个是可以量化的。因此, 理由三: 使用/**/注释代码,有利于公司进行软件质量控管,对程序员绩效考核。 这三个理由,足够说服你么?

编辑:黄飞

声明:本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人,不代表电子发烧友网立场。文章及其配图仅供工程师学习之用,如有内容侵权或者其他违规问题,请联系本站处理。 举报投诉
  • C语言
    +关注

    关注

    180

    文章

    7604

    浏览量

    136687
  • 编译器
    +关注

    关注

    1

    文章

    1623

    浏览量

    49108

原文标题:C语言注释必须用/* */ 的原因

文章出处:【微信号:c-stm32,微信公众号:STM32嵌入式开发】欢迎添加关注!文章转载请注明出处。

收藏 人收藏

    评论

    相关推荐

    C语言应用】如何用C代码生成二维码?

    C语言应用】如何用C代码生成二维码?
    的头像 发表于 08-24 19:01 2184次阅读
    【<b class='flag-5'>C</b><b class='flag-5'>语言</b>应用】如<b class='flag-5'>何用</b><b class='flag-5'>C</b>代码生成二维码?

    何用C语言对汇编语言进行调用

    何用C语言对汇编语言进行调用
    发表于 08-20 22:59

    MSP430_C语言例程注释

    MSP430_C语言例程注释
    发表于 03-12 18:59

    C语言注释删除小工具是什么

    C语言注释删除小工具是一款删除c语言注释并实现编译的工具,如果你喜欢这款软件,就快来IT猫扑下载
    发表于 07-14 08:39

    C语言注释删除小工具的使用教程

    C语言注释删除小工具是什么?C语言注释删除小工具共有几个状态?
    发表于 10-18 06:06

    为什么C语言代码注释/**/通通被换成//呢

    为什么C语言代码注释/**/通通被换成//呢?是什么原因造成的?怎样去解决呢?
    发表于 11-11 08:05

    何用C 语言开发DSP 嵌入式系统

    何用C 语言开发DSP 嵌入式系统 摘要目前很多嵌入式系统以 DSP 为核心构建,但是,采用汇编语言开发DSP 系统存在开发难度大、开发周期长、维护性差等缺点,
    发表于 04-07 10:41 36次下载

    C语言整理注释删除工具应用程序免费下载

      本文档的主要内容详细介绍的是C语言整理注释删除工具应用程序免费下载。
    发表于 12-11 17:49 15次下载
    <b class='flag-5'>C</b><b class='flag-5'>语言</b>整理<b class='flag-5'>注释</b>删除工具应用程序免费下载

    何用C语言实现推箱子游戏项目

    一定的要求,但是这些在我们项目源码里面都会有注释,大家到时候学习的时候千万不要忽略注释注释可以更好地帮你理解代码,尤其是C语言初学者。 本
    的头像 发表于 11-09 16:28 2585次阅读

    何用C语言实现贪吃蛇游戏项目

    ,枚举,联合,文件操作,简单的数据结构 ,并且对逻辑也是有一定的要求,但是这些在我们项目源码里面都会有注释,大家到时候学习的时候千万不要忽略注释注释可以更好地帮你理解代码,尤其是C
    的头像 发表于 11-09 16:38 2444次阅读

    C语言如何注释以及在哪儿注释

    文件注释描述了该文件的内容,如果一个文件只声明,或实现,或测试了一个对象,并且这个对象已经在它的声明处进行了详细的注释,那么就没必要再加上文件注释,除此之外的其他文件都需要文件注释
    的头像 发表于 06-17 09:22 4100次阅读

    C语言应用】如何用C代码生成一维码?

    C语言应用】如何用C代码生成一维码?
    的头像 发表于 08-25 12:42 2435次阅读
    【<b class='flag-5'>C</b><b class='flag-5'>语言</b>应用】如<b class='flag-5'>何用</b><b class='flag-5'>C</b>代码生成一维码?

    何用C语言开发DSP嵌入式系统?

    何用C语言开发DSP嵌入式系统? DSP嵌入式系统开发是一个非常重要的领域,它涉及到设备的控制、数据的处理、系统的优化等多种方面,因此,掌握这方面的技术非常重要。 在本文中,将详细探讨如何用
    的头像 发表于 10-29 17:29 1272次阅读

    C语言中如何实现注释

    C语言中,注释是用来增加代码可读性和注释过程和功能的文本。C语言中支持两种类型的
    的头像 发表于 11-22 10:17 1258次阅读

    c语言怎么把代码全部注释

    要将C语言代码全部注释掉,即不让代码被编译和执行,可以使用注释语句来实现。C语言提供两种
    的头像 发表于 11-22 10:21 7193次阅读