管理感悟：需要什么样的注释

红朝儒生

2016-4-12

关键字：管理程序注释

简介：禁止程序员给程序增加垃圾注释，因为这些垃圾注释对工作不仅没有好处，反而有害。吾要求添加好的注释，也就是有用的注释，即：增加知识点、帮助别人理解相应代码。

　　有同事改代码，加了“add by xxx”、只有函数名之类常见的注释。吾立即阻止：不要写这样的注释。

　　有人就奇怪啦，每个软件公司，都鼓励程序员尽量写注释，怎么到了汝这里，竟然不要别人写注释？

　　吾回答曰：这种没用的注释，吾称之为垃圾注释；而这种垃圾注释，对于工作没有任何帮助，所以必须删除。

　　实际上，这种垃圾注释，不仅不利于工作，反而添乱：

　　看到这种注释，对于工作有任何用处吗？没有。

　　这种注释分散了程序员的注意力，让程序员以为另有含义。

　　增加了代码量。

　　吾主张不要这种垃圾注释，但是依然鼓励好的注释。什么叫好的注释？即有用的注释。什么叫有用？吾思考良久，下了如下定义：

　　增加知识点、帮助别人理解相应代码的注释，就是好的注释。

　　比如，吾调试视频程序崩溃，经过跟踪，发现是因为1088的视频画面高度转移到1080时引起的。这里就要加注释了，说明存在这种情况。吾还到网上学习了多出的8行，是在画面底部，这样就决定了程序的处理算法。为此吾专门加了大段注释。看到此类代码的程序员，学习了这个知识，也就明白了这边的算法原因。

　　注释是否有用？这个又信赖于程序员的看法。如果有用无用都判断不准确，那说明这个程序员不合格。实际上，以吾观察，合格的程序员并不多。当然了，这也是因为吾所言“合格”，其实是要求很高的。

管理感悟：需要什么样的注释相关推荐

管理感悟：听课与收获
管理感悟:听课与收获柳鲲鹏 2017-7-22 关键字:管理听课收获简介:如何听课. 目录讲课费... 1 如何听课... 1 听课的收获... 2 经历相同,为什么认识不同... 2 怎样 ...
管理感悟：作为一个主管，如何解决屁股与脑袋的矛盾
工作中,究竟是屁股决定脑袋,还是脑袋决定屁股? 从员工角度来讲,希望老板经常加工资,活安排得少,来不来上班都无所谓. 从老板角度来说,希望员工不要工资,不吃不喝的加班. 显然,双方的想法都是错误的,所 ...
haribote系统调用工程管理及应用程序阅读注释
[ 1] haribote ipl09.nas 引导程序阅读注释. [ 2] haribote asmhead.nas 从实模式进入保护模式程序阅读注释. [ 3] haribote dsctbl.c ...
管理感悟：当管理者，要做到哪些事
管理感悟:当管理者,要做到哪些事红朝儒生 2017-12-20 关键字:管理管理者计划重点前瞻简介:当管理者,必须要做到哪些事. 目录大多数人不能胜任管理... 1 首先要完成角色转变. ...
管理感悟：加班与忠诚
管理感悟:加班与忠诚红朝儒生 2018-1-4 关键字:管理加班忠诚简介:本文提出忠诚三条件. 转眼又迎来了2018年.祝大家在2018年能够好运连连. 去年12月20号,吾司一所谓技术高手( ...
管理感悟：什么是对企业的忠诚（全新观点）
管理感悟:什么是对企业的忠诚(全新观点) 红朝儒生 2017-4-17 关键字:管理企业忠诚简介:什么是对企业的忠诚?吾认为不能以工作年限来衡量,有三个条件:对认真完成工作,不做对公司有害的事情 ...
管理感悟：主管必须让下属有点怕
管理感悟:主管必须让下属有点怕红朝儒生 2018-2-24 关键字:管理主管下属威信简介:主管要有威信.威信从哪里来?一个是从能力中来,另外一个就是从严格处罚中来.要有威信,不如让下属有点怕 ...
管理感悟：不懂技术如何管理
管理感悟:不懂技术如何管理红朝儒生 2018-2-25 关键字:管理技术简介:隔行不隔理,不懂技术也能进行有效的管理. 有一句话,叫隔行如隔山.所以很多领导发愁,因为面临一个问题:不懂技术,怎么 ...
管理感悟：收拾烂摊子的反省
管理感悟:收拾烂摊子的反省红朝儒生 2016-11-10 关键字:管理主管烂摊子简介:对于制造了烂摊子,不知感激帮忙收拾的人:给出期限要求,让他自己收拾自己制造的烂摊子:收拾不好,按照规定处理 ...
叶武滨老师时间管理感悟分享2
DAY8 时间管理第十讲<轻控股大脑与应用4D原则摆脱紧急事务>小分享: 1. 如何做紧急重要的事以及紧急不重要事务? 4D原则: 第一,完成它 DO 相对比较重要的第二 ...

管理感悟：需要什么样的注释

管理感悟：需要什么样的注释相关推荐

最新文章

热门文章