有哪些小技巧可以提升13个代码注释的效率？

本文共计1853个文字，预计阅读时间需要8分钟。

本文由José M. Aguilar在其博客中首次以西班牙语发表，后经Tim Martin在Aguilar生前授权下进行翻译和修改，并在DevTopics上发布。以下13个小技巧可助你提升效率：

这篇文章是由José M. Aguilar在他卓越的博客中以西班牙语的形式首发，其后Timm Martin在获得Aguilar先生的授权下，对该文章进行翻译、修改，并且在DevTopics上发布。

以下13个小技巧可以使得你的代码在长时间内依然能够保持容易理解和维护。

1. 对不同级别的代码进行注释

对于不同级别的代码块，要使用统一的方法来进行注释。例如：

对于每一个类，需要包含一段简明扼要的描述，作者和上一次修改的时间
对于每一个方法，需要包含这个方法的用途，功能，参数以及返回结果
当你在一个团队里面的时候，采用一套注释的标准是非常重要的。当然，使用一种大家都认可的注释约定和工具（例如C#的XML注释和Java的Javadoc）在一定程度上能推动这项任务。