培养自己写注释的好习惯

 

       注释是很重要的，特别在一些大公司里，对于注释的要求特别高，看一个程序员的水平高低，一般看他的注释就能看出来，所以平常养成写注释的好习惯对应程序员来说是很重要的。一般注释和源代码的比例是1:1，甚至1:2或者1:3。

       自己就有这种体会。别人发来代码要我修改，一看源代码那叫惨不忍睹，密密麻麻的一片，不见一个中文（当然写英文注释还是可以理解的）。修改起来这叫我痛不欲生啊！自己要里弄懂每个变量，每个语句是什么含义，这个代码块是什么作用，如此等等。反正我是受不了这种摧残，还不如叫我自己实现这个功能。所以写好代码的注释不仅是你受用，别人也会受益匪浅。

       优美的代码是必须要有注释的。阅读注释详细、稳妥的代码是种享受，或许只有程序员才能体会其中的乐趣吧。

       平时注意这个习惯，写好注释。一是因为别的程序员会使用你的程序，增加程序的可读性。别人使用起来方便，如果没有注释，别的程序员还不如自己重新写，这样效率或许会快些。二是自己以后也需要阅读，人的记忆不可能永远那么好，总有忘记的时候。所以写好注释可以让自己快速地明白当初自己写代码的含义，这样会事半功倍。

       从现在开始，给代码写上注释吧，让自己走得更稳，更远。

评论

21 楼 qfly888 2012-06-06  

确实很重要，但是也很难办到

20 楼 qinglongyun 2012-06-06  

  

19 楼 z2009zxiaolong 2012-06-04  

命名规范很重要。[size=large][/size]

18 楼 hiblue 2012-06-04  

零注释, 自注释(代码命名合理化),

17 楼 Mybeautiful 2012-06-04  

我与博主的观点正好相反，“优美的代码是不需要写注释的。” 真正的好代码是自注释，可读性强，从方法名，参数名，就知道这个方法是干什么的。注释是多余的，而且往往是错误的（因为没有及时更新）。
如果一个段代码需要写注释去说明它做了什么，那么这段代码有极大地改进空间。

16 楼 fangang 2012-06-04  

其实有时候，写注释也是整理自己思路的时候。有的人写的程序，不仅注释清晰，程序思路也清晰，而有的人，虽然写了注释，只有他自己能看懂，甚至语句都不通顺。这种情况常常是因为写程序的人自己就思路不清晰。

15 楼 toknowme 2012-06-04  

很多时候，注释写好了，也就剩下填代码了，不过这个习惯还是比较难以养成的！

14 楼 toknowme 2012-06-04  

个人认为应该先写注释，再写代码！

13 楼 uuhui 2012-06-04  

注释很重要，但不要为了注释而去写注释！

12 楼 cooljack2009 2012-06-04  

tomjin 写道

注释不要多写，一般没有人会去修改注释，方法改变了，注释还在，很危险。尽量保持代码的可读性，适当加些注释即可。

说的很对  良好的代码可以减少很多注释  注释太多 通常也意味着代码的可读性很差

11 楼 langyahuashi 2012-06-04  

代码的注释写什么，what，how，why，what这部分应该代码就表达了，how应该写清楚，怎么去调用，何时调用

10 楼 jadethao 2012-06-04  

个人认为好的注释对自己对别人都有利！

9 楼 kyfxbl 2012-06-04  

这个观点不一定对的

8 楼 hyj1254 2012-06-04  

代码不会因为注释优美它就优美，烂代码始终是烂代码。看过重构的同学都应该有这种体会：要尽量少写注释，刚好跟lz相反。这不是不要注释，而是应该选择更好的解释代码的方法：用代码自身解释自己。这要求代码职责尽可能单一，命名尽可能合理，以至于无需注释，无形中既解释了代码又提高了质量。注释只在重要api或者难于用代码解释的地方。

7 楼 zhaoy2010 2012-06-04  

  没有注释的代码，命名再不怎么规范，看了想死的心都有

6 楼 bigarden 2012-06-04  

支持楼主的观点，看没有注释的代码实在是头疼特别是较复杂逻辑

5 楼 andy_tm 2012-06-04  

养成良好的习惯比能力更重要,,,

4 楼 tomjin 2012-06-04  

注释不要多写，一般没有人会去修改注释，方法改变了，注释还在，很危险。尽量保持代码的可读性，适当加些注释即可。

3 楼 longhaisheng 2012-06-04  

错误的注释比没有注释的负作用更大，什么都要分情况的

2 楼 dyllove98 2012-06-04  

有些新手的代码 ，就算是写慢了注释...你也不一定能看懂.