关于代码中注释的问题
我看过的代码中注释很少,基本上1/100都占不到。 而我自己写的代码中注释也很少,有时为了赶进度或者当时有灵感写代码一气呵成,就把代码抛在脑后了,在项目要结束的时候也懒得去补了, 还有一点:就是注释和代码的同步更新问题,有些代码会变,而改过代码后注释也会经常忘记改。
我感觉注释很多时候不是用来解释代码的,而是用来记录当时为什么这么做,代码中有什么雷区以及业务相关,我不知道业务相关的东西写在注释中是否得当,不过不写的话会很难让后来的人摸不着头脑,因为我们平时写的代码很多都不是标准的,都是根据业务上的要求来写代码,这样的话如果不用注释来加以说明的话,别人很难理解当时你为什么这样写。
大家以为呢?
------解决方案--------------------你都提到了“懒得补”
显然“懒”不太好,呵呵~
我是即使一气呵成,也会回来补一下,只是多写与少写的问题,而不是写和不写的问题。
------解决方案--------------------板凳,代码怎么能没有注释呢?
------解决方案--------------------不得不说,懒人太多了。靠自觉是不现实的。必须有领导专门督促。
------解决方案--------------------。。。。被强制的必须加注释。还悲剧的必须达标
------解决方案--------------------最好的代码是没有注释的代码。
注释顶多用用 //TODO: //FIXME:
------解决方案--------------------雷区话,注释一定要写的详细点;
业务性代码,可以少加注释,最好的方法就是你声明的变量和方法,在遵循驼峰原理的基础上,从字面上就可以看出要干什么,比如:getUserInfoByUserId,虽然啰嗦点,但是一看就知道是干啥的。
对于你提出的因为懒得加注释,所以随着代码的量的积累,后来即使有时间也懒得加了。这也看出你们公司的代码质量是处在什么水平、代码管理处于何种程度、文档化要求让人心寒、代码把关和审核让人担忧!
对自己负责点,从注释开始做起吧
------解决方案--------------------