Python名言：Code Tells You How，Comments Tell You Why！

The best way to learn a programming language is to write a lot of code and read a lot of code.

到现在为止，我们在程序（以及交互模式）中键入的所有一切都是交给计算机的指令。不过，还可以在程序中为你自己加入一些说明，描述这个程序做什么，怎么做，这是一个很好的想法。这样能够帮助你（或者其他人）以后查看程序，了解原先你想做什么。

在计算机程序中，这些说明就称为注释（comment）。

增加注释

注释是给你看的，而不是让计算机执行的。下面是一个程序文档注释：

文档就是关于一个程序的信息，描述了程序并说明它是如何工作的。注释是程序文档的一部分，不过在代码本身以外，文档还包括其他部分，文档描述以下内容：

为什么写这个程序（它的用途）

这个程序是谁写的

这个程序面向什么人（它的用户）

如何组织

注释是程序文档的一部分，更大、更复杂的程序往往有更多的注释，计算机运行程序时会忽略这些注释。

#注释

Python中向程序增加注释有两种方法。

单行注释

在任何代码行前面加上“#”符号就可以把它变成一个注释。

如果运行这两行代码，会得到下面的输出：

程序运行时第一行会被忽略。注释（以#字符开头的代码行）只是用来方便你和其他人读懂代码的。

行末注释

还可以在一行代码的最后加注释，像下面这样的：

注释从#字符开始。#之前的所有内容都是正常的代码行，在它后面的所有内容则是注释。

多行注释

有时你可能想使用多行注释。可以使用多行，每行前面都有一个“#”字符，像下面这样：

多行注释可以很好地“突出”代码段，使你读代码时能清楚地区分不同代码段。可以用多行注释来描述一段代码要做什么。程序最开始的多行注释可以列出作者的名字、程序名、编写或更新的日期，以及你认为可能有用的任何其他信息。

三重引号字符串

Python中还有一种方法可以相当于多行注释。只需要建立一个没有名字的三重引号字符串。三重引号字符串是一个可以跨多行的字符串。所以可以这样写：

你也可以把双引号换成单引号，像下面这个效果也是一样的：

因为这个字符串没有名字，而且程序对这个字符串不“做”任何处理，所以它对程序的运行没有任何影响。它相当于一个注释，尽管从严格的Python术语来讲，这并不是一个真正的注释。

从以上的两种方法的例子中，我们可以看到，在IDLE编辑器键入一些注释，可以看到注释会用不同的颜色显示。这是为了帮助你更容易地读代码。

IDLE中注释的默认颜色是红色的。三重引号字符串因不是真正的Python注释，所以它们的颜色会不同，显示的是绿色，而绿色在IDLE中是字符串的默认颜色。

最后的话

每个程序文件的注释都有必要标注。我们都不是回记高手，当我们回头看几年前、几个月前或者是几个星期前，甚至只是昨天才写的程序时，可能完全看不明白，这往往因为他们没有加入足够的注释来解释程序是如何工作的。至于应该在注释中放什么内容并没有严格的规定，不过建议你尽可能增加注释。

在我们调试程序时，如果只希望某些部分运行而将另外的部分忽略，通过注释方法也会很有用。你只需要在那些你希望计算机忽略的代码行前加一个“#”就可以了。

END

回顾

注释只是为了方便你（和其他人），而不是用来帮助计算机。

ˆˆ注释还可以用来隔离部分代码，不让它们运行。

ˆˆ可以使用三重引号字符串作为一种跨多行的注释。

测试题

本章内容这么简单，继续学习下一篇吧！