摘要：
有良好的注释习惯，不一定是合格程序员；但没有良好注释习惯，一定不是合格程序员。 程序注释，我体会比较深刻，因为我的机房收费系统重构就是因为注释写的不好。 记得刚刚开始接触编程的时候，完全不懂注释的意义，但学习别人的代码时，发现人家都有注释，于是也学着用注释点缀自己的程序，经过将近两年的积累，我对注释有了比较深刻的认识，接下来就与大家共享一下自己的经验。 前篇废话，其实关于注释的讨论、优点、注意事项等等，网上有很多很多，本小菜在此从实际应用角度出发，分享经验。一、注释可以帮助理清思路。写注释不仅仅是关爱他人，让别人维护起来更加轻松，实际上写注释对理清思路有很大帮助。正所谓代码未动，注释先行。举. 阅读全文
摘要：
1. Comment each level（每个级别的注释有统一的风格）注释每一个代码块，并且在各个级别的代码块上，要使用统一的注释方法。例如：对于类，应包含简单的描述、作者以及最近的更改日期对于方法，应包含目的的描述、功能、参数以及返回值使用统一的注释规则对于一个团队是非常重要的。当然，更加推荐使用注释的约定和工具（例如，C#的XML或Java的Javadoc），它们会是注释变得更加容易。2. Use paragraph comments（对段落注释）将代码块分成若干完成独立功能的“段落”，并在每个“段落”前添加注释，向读者说明“即将发生什么”。// Check that all data 阅读全文