摘要:
1. Comment each level(每个级别的注释有统一的风格)注释每一个代码块,并且在各个级别的代码块上,要使用统一的注释方法。例如:对于类,应包含简单的描述、作者以及最近的更改日期对于方法,应包含目的的描述、功能、参数以及返回值使用统一的注释规则对于一个团队是非常重要的。当然,更加推荐使用注释的约定和工具(例如,C#的XML或Java的Javadoc),它们会是注释变得更加容易。2. Use paragraph comments(对段落注释)将代码块分成若干完成独立功能的“段落”,并在每个“段落”前添加注释,向读者说明“即将发生什么”。// Check that all data 阅读全文