原标题:【经济金融及Python应用讲义】Python编程规范之注释
来源:计量经济学服务中心
经济金融及Python应用讲义 一、注释 1、为什么需要注释
如果代码的编写者在这里添加了备注说明,那么读者很快就能理解该段代码的含义了。
可以发现,在编写代码的过程中,我们需要对代码进行解释与说明,以增强程序的可读性。一些复杂的程序往往需要很长的代码才能实现。如果没有注释,即使创作者本人也很难在第一时间理解代码的含义。在Python中,我们可以使用注释语句来对代码进行说明,并且注释部分的文字不会被Python执行。具体而言,给代码编写注释通常源于以下三个目的之一:
第一,注明代码的作者和版权信息。在编写代码的实际过程中,我们会在程序的开头注明作者、日期、版权以及用途等信息。在此情况下,我们可以使用单行或者多行注释进行说明。
第二,对代码的设计原理及用途做出解释。在实际运用中,一篇代码往往有众多使用者,为了增加代码的可理解性,通常需要代码的作者对其代码的逻辑和设计原理做出说明。对于一段实现特定功能的代码,我们往往会在整段代码前,对其将要实现的具体功能进行注释说明。对于一于代码,如果其含义并非一目了然,我们也需要对单行代码的功能或者变量所代表的含义进行注说明。
第三,提高程序调试的效率。在调试程序时,被注释的代码不会被Python执行,因此我们可充分利用注释来把不需要调试的代码圈出,这样可以帮助程序员快速地定位代码发生错误的位置,大幅减少程序调试的工作量。
Python中的注释有单行注释和多行注释
注释分为单行注释和多行注释,这部分内容与《高级计量经济学及stata应用研讨会》中“基于stata的数据分析流程”是一致的,即需要学习 注释与断行