注释皈元

注释可以做很多事，只有与程序的可读性有关的内容在本文讨论之列

引子
初学编程者往往会出现注释过少，学过编程者往往会出规注释过多。过多还是过少是都是问题，但这两种情况出现的原因不同，初学的注释过少是因为不知道写注释，学过的是不知道注释写什么。

注释究竟要不要写？写要写成什么样子？
首先要搞清楚什么是注释？注释是程序的一部分，出现在项目文件中，注释不是代码，编译将被忽略。其次注释是做什么用的？注释的出现是为了提高程序的可读性，注释不能改善代码的可读性。也就是说注释是代码的延伸，是为了提高代码的可读性，也就是程序的可维护性。代码不是注释的完整实现，这样的注释应该出现在设计文档中。编码规约是经验的总结，计算机科学是一门实践科学，所以编程者的经验对代码的可读性很重要。经验就是经验，清者自清，各位大侠应该各有修为吧。

好的代码与好的注释
没有注释！=过多注释。有注释的代码不一定是好代码，太多太滥，该写不写。没有注释的代码不一定不是好的代码，完全没必要写注释。但事情往往是，好的代码不是好的代码，因为没有注释，不好的代码是好的代码，因为有很多的注释，甚至比代码还多。

注释的本质
代码也好，注释也好，归根结底都是为了实现某个功能而编写的计算机文档，是计算语言对自然语言的重现，计算语言存在不足，无法将自然语言用计算语言完美的表现出来，所有就有了注释。

如果能够认识到这些，那么关于注释的很多问题都会有一个解决的方向。