《像计算机科学家一样思考Python（第2版）》——2.7 注释

xiaoxiao2024-03-30 11

本节书摘来自异步社区《像计算机科学家一样思考Python（第2版）》一书中的第2章，第2.7节，作者[美] Allen B. Downey，赵普明译，更多章节内容可以访问云栖社区“异步社区”公众号查看。

当程序变得更大更复杂时，读起来也更困难。形式语言很紧凑，经常会遇到一段代码，却很难弄清它在做什么、为什么那么做。

因此，在程序中加入自然语言的笔记来解释程序在做什么，是个好主意。这种笔记被称为注释（comments），它们以#开头：

# compute the percentage of the hour that has elapsed percentage = (minute * 100) / 60

在这个例子里，注释单独占据一行。也可以把注释放到代码行的结尾：

percentage = (minute * 100) / 60 # percentage of an hour

从#开始到行尾的注释内容都会被解释器忽略掉—它们对程序本身运行没有任何影响。

注释最重要的用途在于解释代码并不显而易见的特性。我们可以合理地认为读者可以看懂代码在做什么，因此使用注释来解释为什么这么做，要有用得多。

下面这段注释与代码重复，毫无用处：

v = 5 # 将5赋值给v

而下面这段注释则包含了代码中看不到的有用信息：

v = 5 # 速度，单位是米/秒

选择好的变量名称，可以减少注释的需要，但长名字也会让复杂表达式更难阅读，所以这两者之间需要衡量舍取。