购买
下载掌阅APP,畅读海量书库
立即打开
畅读海量书库
扫码下载掌阅APP

2.8 注释

当程序变得更大、更复杂时,读起来也更困难。程序的各部分之间紧密衔接,想依靠部分代码了解整个程序的功能很困难。在现实中,我们经常很难弄清楚一段代码在做什么、为什么那么做。

因此,在程序中加入自然语言的笔记解释程序在做什么是一个不错的主意。这种笔记称为注释(comments),注释必须以“#”符号开始。

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

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

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

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

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

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

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

选择好的变量名可以减少注释,但长名字会让复杂表达式更难阅读,所以这两者之间需要权衡取舍。 xS1By4bzlENahe+H5CT0vwGhRx7q477/xOxkJ36KrDjea1krqxKX+ejpizRMJGr6

点击中间区域
呼出菜单
上一章
目录
下一章
×