13个代码注释的小技巧
13个代码注释的小技巧 这篇文章是由José M. Aguilar在他卓越的博客中以西班牙语的形式首发，其后Timm Martin在获得Aguilar先生的授权下，对该文章进行翻译、修改，并且在DevTopics上发布。 以下13个小技巧可以使得你的代码在长时间内依然能够保持容易理解和维护。 1. 对不同级别的代码进行注释 对于不同级别的代码块，要使用统一的方法来进行注释。例如： 对于每一个类，需要包含一段简明扼要的描述，作者和上一次修改的时间 对于每一个方法，需要包含这个方法的用途，功能，参数以及返回结果 当你在一个团队里面的时候，采用一套注释的标准是非常重要的。当然，使用一种大家都认可的注释约定和工具（例如C#的XML注释和Java的Javadoc）在一定程度上能推动这项任务。 2. 使用段落注释 首先把代码块分解成多个“段落”，每一个段落都执行单一的任务；然后在每一个“段落”开始之前添加注释，告诉阅读代码的人接下来的这段代码是干什么用的 复制内容到剪贴板 代码: // 检查所有记录都是正确的 foreach (Record record in records) { if (rec.checkStatus()==Status.OK) { . . . } } // 现在开始进行处理 Context ctx = new ApplicationContext(); ctx.BeginTransaction(); . . . 3. 对齐注释行 对于那些在行末写有注释的代码，应该对齐注释行来使得方便阅读 const MAX_ITEMS = [...]
