原创 一线研发之声 之 C代码注释引发的“血案” (二)

2013-12-23 16:23 2622 39 48 分类: 消费电子

上接:一线研发之声 之 C代码注释引发的“血案 (一)

 

    我开始思考,还有什么强劲有力的理由,来支持我恪守的真理:c语言代码注释必须使用/**/.

有的!
     倘若所有代码里面的注释用到/**/时,当你要注释掉这段代码时,如果不想忍受编译器的嵌套报警,又懒得把一个个/**/换成//的话。那么你还有如下选择。
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”是一个如此的醒目,很容易成为一个评估软件质量、工作绩效的搜索关键词。从管理的角度,这个是可以量化的。因此,
理由三: 使用/**/注释代码,有利于公司进行软件质量控管,对程序员绩效考核。
 
这三个理由,足够为自己代言吗?
 
PARTNER CONTENT

文章评论9条评论)

登录后参与讨论

用户404269 2014-1-5 17:28

迈向管理职位的“畏惧沟通”心理障碍

用户439555 2014-1-2 15:32

解决方法就是大家坐在一起, 制定规范. 到底是用 // 还是 /**/. 不然这么下去, 扯不完的蛋.

用户1406868 2014-1-1 19:04

不错,你可以为自己代言。

用户1639872 2013-12-25 00:35

好的,也谢谢您的承上启下。

用户1406868 2013-12-24 12:32

那是你们没有规定好编码规范。 另外 即便没有编码规范,就因为这个 你还折腾这么久 我觉得你们就是闲的

allen_zhan_752827529 2013-12-24 11:44

理论上你是正确的, 我支持你. 实际的使用上, 支持合并您的代码的那位工程师, 在我的代码中, 极少见 /**/, 理由同那位工程师. 特别在移植例程代码, 进行逐行逐段或全文件屏蔽, 分析调试功能, /**/ 导致工作量急剧增加. 我的 /**/ 几乎只用于文件头部的 description, including purpose, funcitons, author, email, written time or modified time, history, as so on. So it just is different for the coders' style, never mind.

用户1639928 2013-12-24 10:56

学习一下

用户1602177 2013-12-24 10:20

建议博主将写好的内容先复制到“.TXT”文档,然后再复制到编辑框中,这样就会节省很多字符空间~~如果从其他网站或者word中直接复制粘贴就会因为它们的格式而生成很多隐形的字符~~

用户1639872 2013-12-22 00:09

字数限制,否则我不用分成两篇。
相关推荐阅读
用户1639872 2014-03-16 12:07
营销自己,实名还是“艺名”好?
积累了一些技术心得,想在网上发点文章博点人气,本着先有名后有利的想法。多数人都是用个“艺名”,用马甲在混。问题在于:马甲这个东西,优点就是好记,而且有一种神秘感,也许自己就是个屌丝,但文章过硬,也...
用户1639872 2014-03-11 23:55
当心中有了牵挂
       上个周末,回老家看2周多的女儿。离别的时候,我不敢扭头就上了车,眼泪就不可遏地直流下来...         以前看宝宝时,离开时只要说句bye,她就呵呵地和你bye,甚至头也不...
用户1639872 2014-01-19 01:29
不知幸亦或不幸,路在何方?
晚上公司尾牙,鉴于往年素餐尾牙吃不饱的经验。部门内部几天前就发起了一场尾牙结束后的k歌聚会。当时没有报名,感觉k歌确实没什么吸引我的。尾牙结束回家的路上,搭乘同事的车,耐不住满车同事的煽动,想想还...
用户1639872 2013-12-25 00:27
一线研发之声 之 完美主义者的程序员特征 <二>
3.空格、换行、常量替换、{}保护、还有效率。 if((long_state_var==1)||(long_state_var==2)||((ch>0x2F)&...
用户1639872 2013-12-24 10:46
一线研发之声 之 完美主义者的程序员特征 <一>
    观文识人,代码无疑是了解一个程序员的最佳途径。     且不论算法思路,单就代码的界面风格,便可知一二。     1. 追求精美的对齐。 尽可能精确到每一个"断点",是他的...
EE直播间
更多
我要评论
9
39
关闭 站长推荐上一条 /3 下一条