摘要：
本文发表在作者José M. Aguilar的博客Variable Not Found，后来由Timm Martin翻译成英文发表在DevTopics上。以下是如何注释代码的13tips，它们会在日后帮助你更容易理解和维护代码。1. Comment each level（每个级别的注释有统一的风格）注释每一个代码块，并且在各个级别的代码块上，要使用统一的注释方法。例如： 对于类，应包含简单的描述、作者以及最近的更改日期 对于方法，应包含目的的描述、功能、参数以及返回值使用统一的注释规则对于一个团队是非常重要的。当然，更加推荐使用注释的约定和工具（例如，C#的XML或Java的Java 阅读全文