1.6　注释及文档字符串

1.6.1　通过注释为程序添加功能说明

和大部分脚本及UNIX-shell语言一样，Python也使用#标示注释。从#开始，直到该行结束的内容，都是注释。

被注释的内容，在程序功能方面没有任何作用，但是良好的注释习惯可以方便其他人了解你的程序功能，也方便自己在日后能读懂曾经写过的代码。

当然你也可以在测试代码时，把一些不希望执行的代码先注释掉，使其不发挥作用，而不是删除它们。

小技巧：在PyCharm中，可以把要注释的几行选中，按组合键Ctrl + /。按组合键Ctrl + / 还可以把已经注释的内容取消注释。

1.6.2　使用文档字符串添加帮助信息

在使用Linux操作系统时，如果想获取帮助，可以执行man命令。Python也提供了类似man的命令。在Python中，可以使用help（）函数获取相关的帮助信息。例如，想获取len（）内部函数的使用方法，可以通过下面的方式实现：

查看帮助时，如果内容过长，则可以通过按回车键或空格键来翻页；如果想要退出帮助，则按小写字母q键。

我们自己写的程序也能实现这样的功能，而且并不困难。下面举的例子用到了函数，这里仅仅作为演示，如果不能理解，那就跳过这一部分，对知识理解不会有任何影响。

创建一个名为star.py的文件，输入以下内容：

在上面的示例中，用到了三引号（三个连续的双引号，或者三个连续的单引号），三引号表达的意思和双引号、单引号完全一样，只不过它能够保存输入时的格式，如允许在引号内输入回车。如果在双引号或单引号内包含了多行，那么将会出现语法错误。注意，在star module下面有一个空行。

接下来，我们需要做的是，在交互解释器中将star.py作为模块导入（一个Python文件就是一个模块文件，模块名就是文件名，但是不包括.py）并查看帮助。如下所示：

三引号中的第一行出现在了NAME后面，其余行作为DESCRIPTION（描述）。pstar（）函数也有相关说明。

如果只想查看pstar（）函数的帮助，则可以这样做：