摘要：对齐注释行对于那些在行末写有注释的代码，应该对齐注释行来使得方便阅读有些开发人员使用tab来对齐注释，而另外一些人会用空格来对齐。
1. 对齐注释行对于那些在行末写有注释的代码，应该对齐注释行来使得方便阅读有些开发人员使用tab来对齐注释，而另外一些人会用空格来对齐。由于tab在不同的编辑器和集成开发环境中会有所不同，所以最佳的方法是使用空格来对齐注释行。2. 使用统一的风格有些人觉得注释应该让非程序员也能看懂。另外一些人觉得注释需要面对的读者只是程序员。无论如何，正如Successful Strategies for Commenting Code中所说的，最重要的是注释的风格需要统一，并且总是面向相同的读者。就自己而论，我怀疑非程序员是否会去读代码，所以我觉得注释应该面向程序员来写。3. 对不同级别的代码进行注释对于不同级别的代码块，要使用统一的方法来进行注释。例如：对于每一个类，需要包含一段简明扼要的描述，作者和上一次修改的时间对于每一个方法，需要包含这个方法的用途，功能，参数以及返回结果当你在一个团队里面的时候，采用一套注释的标准是非常重要的。当然，使用一种大家都认可的注释约定和工具(例如C#的XML注释和Java的Javadoc)在一定程度上能推动这项任务。4. 使用段落注释首先把代码块分解成多个“段落”，每一个段落都执行单一的任务;然后在每一个“段落”开始之前添加注释，告诉阅读代码的人接下来的这段代码是干什么用的5. 不要侮辱阅读者的智慧这不单把时间浪费在写没用的注释上面，同时也在分散读者的注意力。6. 直截了当不要在注释里面写过多的废话。避免在注释里面卖弄ASCII艺术，写笑话，作诗和过于冗长。简而言之就是保持注释的简单和直接。
4 赞
- 标签
- 网站制作代码注释
公安备案： 苏公网安备 34019102000054号