python代码注释规范-Python编程规范之注释

来源：计量经济学服务中心

经济金融及Python应用讲义

一、注释

1、为什么需要注释

如果代码的编写者在这里添加了备注说明,那么读者很快就能理解该段代码的含义了。

可以发现，在编写代码的过程中，我们需要对代码进行解释与说明，以增强程序的可读性。一些复杂的程序往往需要很长的代码才能实现。如果没有注释，即使创作者本人也很难在第一时间理解代码的含义。在Python中，我们可以使用注释语句来对代码进行说明，并且注释部分的文字不会被Python执行。具体而言，给代码编写注释通常源于以下三个目的之一：

第一，注明代码的作者和版权信息。在编写代码的实际过程中，我们会在程序的开头注明作者、日期、版权以及用途等信息。在此情况下，我们可以使用单行或者多行注释进行说明。

第二，对代码的设计原理及用途做出解释。在实际运用中，一篇代码往往有众多使用者，为了增加代码的可理解性，通常需要代码的作者对其代码的逻辑和设计原理做出说明。对于一段实现特定功能的代码，我们往往会在整段代码前，对其将要实现的具体功能进行注释说明。对于一于代码，如果其含义并非一目了然，我们也需要对单行代码的功能或者变量所代表的含义进行注说明。

第三，提高程序调试的效率。在调试程序时，被注释的代码不会被Python执行，因此我们可充分利用注释来把不需要调试的代码圈出，这样可以帮助程序员快速地定位代码发生错误的位置，大幅减少程序调试的工作量。注释是数据分析里面的一个必要方法，可以使得代码更加清晰易读，方便别人能够识别。确保对模块, 函数, 方法和行内注释使用正确的风格 。

Python中的注释有单行注释和多行注释

注释分为单行注释和多行注释，这部分内容与《高级计量经济学及stata应用研讨会》中“基于stata的数据分析流程”是一致的，即需要学习注释与断行单行注释是以# 开始 这就是第一种注释方法

多行注释，可以使用三个双引号或者三个单引号，即：多行注释用三个单引号 """ 或者三个双引号 """ 将注释括起来

2、单行注释

表示单行注释

在Jupyter中，选中命令行，然后快捷键为：ctrl+/

单行注释

在Python中，使用“#”作为单行注释的符号。从符号“#”开始直到换行为止，“#”后面所有的内容都作为注释的内容，并被Python编译器忽略。

语法如下：

# 注释内容

单行注释可以放在要注释代码的前一行，也可以放在要注释代码的右侧。例如，下面的两种注释形式都是正确的。

第一种形式：

# 要求输入身高，单位为m（米），如1.70

height=float(input("请输入您的身高："))

第二种形式：

height=float(input("请输入您的身高：")) # 要求输入身高，单位为m（米），如1.70

上面两种形式的运行结果是相同的

说明：在添加注释时，一定要有意义，即注释能充分解释代码的功能及用途。

注意：注释可以出现在代码的任意位置，但是不能分隔关键字和标识符。

总结：**注释除了可以解释代码的功能及用途，也可以用于临时注释掉不想执行的代码。

3、多行注释

**Python中多行注释可以用多个 # 号，还有两个 """ 或者两个""" 链接，然后就可以了。

在Python中，并没有一个单独的多行注释标记，而是将包含在一对三引号（"""……"""）或者（"""……"""）之间，并且不属于任何语句的内容都可视为注释，这样的代码将被解释器忽略。由于这样的代码可以分为多行编写，所以也称为多行注释。"""

stata

stata

stata

"""

"""

stata

stata

stata

"""

多行注释通常用来为Python文件、模块、类或者函数等添加版权、功能等信息。例如，下面代码将使用多行注释为1.py文件添加版权、功能及修改日志等信息：

"""

@ 版权所有：计量经济学服务中心©版权所有

@ 文件名：Python编程规范.py

@ 文件功能描述：编程规范

@ 创建日期：2017年10月1日

@ 创建人：计量经济学服务中心微信公众号编辑团队

@ 修改标识：2017年10月2日

@ 修改描述：

@ 修改日期：

"""

◆◆◆◆

精彩回顾