《Python 3.x入门到应用实践》 —1.7.2 程序注释

1.7.2  程序注释

有不少人认为编写程序只要程序运行得出结果就好，还要拖泥带水地写什么注释，真是自找麻烦。其实，随着程序代码的规模日益庞大，现在软件工程的重点就在于可读性与可维护性，而适时使用“注释”就是达到这两个重点目标的主要方法。注释不仅可以帮助其他的程序设计人员阅读程序内容，在日后程序维护时，清晰的注释可以节省不少维护成本。

注释是用来说明程序代码或者提供其他信息的描述文字，Python解释器会忽略注释，因此注释并不会影响执行结果。注释的目的是增加程序的可读性，尤其是在大型程序开发中，更是需要简单而清晰的注释，比如在注释中记录程序的目的、变量以及返回值的说明、算法的主要步骤、作者以及修改日期等信息。

Python语言的注释有两种，即单行注释与多行注释。

1. 单行注释

单行注释符号是“#”，在“#”之后的文字都会被当成注释，例如：

#这是单行注释

2. 多行注释

多行注释是以三对引号来引住注释文字，引号是成对的双引号，例如：

"""

这是多行注释

用来说明程序的内容都可以写在这里

"""

也可以用三对单引号：

'''

这也是多行注释

用来说明程序的内容都可以写在这里

'''