2.7 注释
随着程序变得越写越长,越来越复杂,它们的可读性也越来越差。形式语言是稠密的, 通常很难在读一段代码后,说出其做什么或者为什么这样做。
1string concatenation , # compute the percentage of the hour that has elapsed # 计算逝去的时间占一小时的比例 percentage = ( minute * 100) / 60 ,p ercentage = ( minute * 100) / 60 # percentage of an hour ,v = 5 # assign 5 to v ,v = 5 # velocity in meters / second .
16 第二章 变量、表达式和语句
因此,在你的程序中需要用自然语言做些笔记,解释程序将做些什么。这些笔记被称为
注释 (comments),以 # 符号开始。
r
此例中,注释独占一行。你也可以将注释放在行尾:
r
从# 开始到行尾的所有内容都会被解释器忽略—其内容对程序执行不会有任何影响。
在注释中记录代码不明显的特征,是最有帮助的。假设读者能够读懂代码做了什么是合 理的;但是解释代码为什么这么做则更有用。
下面这个注释只是重复了代码,没有什么用:
r
下面的注释包括了代码中没有的有用信息:
r
好的变量名能够减少对注释的需求,但是长变量名使得表达式很难读,因此这里有个平 衡问题。