2.8　注释

注释是代码的辅助部分，是帮助代码阅读者更好地理解代码的辅助工具。

当程序在逐步变得更大、更复杂时，程序阅读的困难性也在逐步增加。程序的各部分之间紧密衔接，想依靠部分代码了解整个程序的功能变得更困难。在现实中，要快速弄清楚一段代码在做什么、为什么这么做并不容易，经常需要仔细研究一段时间。

因此，在程序中加入描述性的语言记录并解释程序在做什么是一个不错的主意。这种语言记录称为注释（comments），注释一般以“#”符号开始。

注释可以单独占一行，也可以放在语句行的末尾。比如在交互模式下输入：

>>> # 打印1+1的结果
>>> print(1 + 1)
2
>>> print(1 + 1) # 打印1+1的结果
2

从符号“#”开始到这一行末尾，之间所有内容都被忽略，这部分对程序没有影响。注释信息主要是方便程序员工作，一个新来的程序员通过注释信息能够更快地了解程序的功能。程序员在经过一段时间后，可能对自己的程序不了解了，利用注释信息能够很快熟悉起来。

注释最重要的用途在于解释代码并不显而易见的特性。比如，在以下代码中，注释与代码重复，毫无用处。

>>> r=10    #将10赋值给r

下面这段代码注释包含代码中隐藏的信息，如果不加注释，就很难让人看懂是什么意思（虽然在实际中可以根据上下文判定，但是需要浪费不必要的思考时间）。

>>> r=10    #半径，单位是米

当然，有时为了更加直观地阅读代码，会给变量取一个比较长的变量名，通过取长变量名或许可以减少注释，但长变量名或许会让复杂表达式更难阅读，所以在取长变量名或增加注释这两者之间需要权衡取舍。

一般在编码时，注释不是必需的，但是好的注释可以为编写的代码增添不少色彩。能把注释写的漂亮得程序员，一定是一个优秀的程序员。