提高代码可读性的十大注释技巧
本文介绍了十种提高代码可读性的主要注释技术：许多程序员编写代码而不注意代码的可读性，让别人花更多的时间阅读代码。事实上，只要一个程序员写的代码，他应该注意注释的代码和注释的代码在一个合理的格式，方便他人查看代码，便于自己以后查看。这里是注释十秘诀：
1。逐层标注
为每个代码块添加注释，并在每个层上使用统一的注释方法和样式：
对于每个类，包括摘要信息、作者信息和最新修订日期等。
对于每个方法，它包括使用、函数、参数和返回值。
它是在团队工作中使用标准化的注释尤为重要。当然，注释规范和工具的使用（如XML的C #，javadoc在java）能更好的促进完成注释工作更好。
2。使用分段标注
如果有多个代码块，并且每个代码块完成一个任务，那么在向读者解释此代码的功能之前添加一个注释到每个块中：
所有数据记录检查
是否正确
foreach（记录记录）
{
如果（rec.checkstatus（）= =状态。OK）
{
..
}
}
我们开始执行
事务
语境CTX =新的应用（）；
ctx.begintransaction（）；
..
三.在代码行之后添加注释
如果是添加注释的每一行行的代码，很容易的每一行代码后添加线的注释后理解。例如：
const max_items = 10；包 / /最大数量
const MASK = 0x1F； / /屏蔽位TCP
在分离代码和注释时，一些开发人员使用tab键，而另一些则使用空格键。然而，由于各种编辑器和IDE工具之间的tab键的性能不一致，所以最好的方法是使用空格键。
4。不要侮辱读者的智慧。
避免以下明显的注释：写这些无用的笔记会浪费你的时间，并会转移读者对代码细节的理解。
如果（a = 5） /如果a等于5
计数器= 0； /将计数器设置为零
5。礼貌点
避免粗鲁的评论，例如：注意，一个愚蠢的用户会输入一个负数，或者只是从原始无能的开发人员手中解决问题。这样的注释可以反映出作者是多么糟糕，而且你永远不知道谁会读注释。可能是你的老板，你的客户，或者你刚刚侮辱过的不称职的开发人员。
6。关注要点
不要写太多的笔记，需要翻译和理解。避免ASCII艺术，有趣的，诗意的，和hyperverbosity笔记。简而言之，保持注释简单明了。
7。使用一致的注释样式
有些人认为，注释应写在某种程度上，他们可以由非程序员的理解。有人认为注释是由开发商的理解。在任何情况下，对于注释代码的成功策略定义和解释注释的一致性和目标读者。就我个人而言，我怀疑大多数非程序员会读代码注释，所以应该对其他开发人员。
8。使用唯一的标签
在团队工作中，为了便于与其他程序员交流，应该使用一组一致的标记来注释它。
int估计（int x，int y）
{
实现计算：
返回0；
}
注释标签不应该用于解释代码，它只会引起信息的注意或传输。如果使用这种技术，记得跟踪并确认信息是什么。
9。在代码中添加注释
当你写代码的时候加一个注释，这是一个清晰而完整的想法，如果你在代码的结尾添加相同的注释，它会花费你两倍的时间，我没有时间写笔记。我很忙，工程延期了。这是一个不写注释的借口。一些开发人员觉得在代码清除线程之前应该先写注释：
public void ProcessOrder（）
{
当然，这些产品是可供使用的。
客户是有效的检查
向商店发送的订单
生成
}
10。为自己注释代码
当注释的代码，考虑谁不仅保持你的代码在未来的开发者，你也可以自己去看看。在Phil Haack大师的话：一行代码显示在屏幕上，你的代码的维护者。所以，对我们的好（坏）的音符，我们将第一受益人（受害人）。