2.2.2 代码注释

在大多数编程语言中，注释是一项很有用的功能。注释是程序员在程序代码中添加的一行或多行说明信息，在编程中是很重要的部分。由于注释不是程序的组成部分，所以它是不被计算机执行的，这样一来就可以借用注释来删除或跳过一部分暂时不需要执行的代码。例如，在如下代码中，第1行就是一条注释，会被编译器或解释器略去，是不被计算机执行的。

【范例2-3】代码注释。

Python有两种使用注释的方法：单行注释和多行注释。单行注释是在每行前面输入“＃”，“＃”后面的内容都会被Python解释器所忽略，如下：

多行注释是使用3个单引号来添加注释的，如下：

1.注释的意义

在程序中编写注释的目的是表明代码要做什么，以及是如何做的。在项目开发期间，程序员可能对程序的工作原理了如指掌，但过一段时间后，就有可能遗忘部分细节问题。当然，没有注释的程序是可以花费时间重新研究代码来确定各部分的工作原理的，但这势必会浪费测试员和其他人很多时间和精力。通过编写注释，以清晰自然的描述语言对程序解决方案进行阐述，可以节省他们很多时间和精力。

2.注释的主要用途

注释在程序开发中的用途主要体现在如下几个方面。

（1）标注软件作者及版权信息。

在每个程序源代码文件的开始增加注释，标明编写代码的作者、日期、用途、版权声明等信息。根据注释内容的多少，可采用单行或多行注释。

（2）注释代码原理和用途。

在程序关键代码附近增加注释，解释关键代码的用处、原理及注意事项，增加程序的可读性。由于程序本身已经表达了设计意图，所以，为了不影响程序阅读的连贯性，程序中的注释一般采用单行注释，标记在关键行，与关键代码同行。对于一段关键代码，可以在附近添加一个多行注释，或者多个单行注释，给出代码设计原理等信息。

（3）辅助程序调试。

在调试程序时，可以通过单行或多行注释，临时去掉一行或多行与当前调试无关的代码，辅助程序员找到程序出现问题的可能位置。