以下python注释代码,Python 注释规范

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

　　金融和Python应用的课堂讲稿

　　一.说明

　　1.为什么需要评论？

　　如果代码的作者在此添加注释，读者很快就会理解代码的含义。

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

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

　　其次，说明代码的设计原则和目的。实际上，一个代码通常有许多用户。为了增加代码的可理解性，代码的作者通常需要解释代码的逻辑和设计原理。对于实现特定功能的一段代码，我们往往会在整段代码之前对它将要实现的特定功能进行注释。对于一个代码，如果它的含义不是一目了然，我们还需要解释单行代码的作用或者变量所代表的含义。

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

　　Python中的注释包括单行注释和多行注释。

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

　　对于多行注释，可以使用三个双引号或三个单引号，即使用三个单引号或三个双引号将注释括起来。

　　2.单行注释

　　表示单行注释

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

　　注释

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

　　语法如下：

　　#评论内容

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

　　第一种形式：

　　#您需要输入以米为单位的高度，例如1.70。

　　Height=float(输入(请输入您的身高：))

　　第二种形式：

　　Height=float(input(请输入您的身高：)#要求您以m(米)为单位输入身高，如1.70。

　　以上两种形式的操作结果是一样的。

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

　　注意：注释可以出现在代码中的任何地方，但是关键字和标识符不能分开。

　　总结：* *注释不仅可以解释代码的功能和用途，还可以用来临时注释掉不想执行的代码。

　　3.多行注释

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

　　在Python中，没有单个的多行注释标记，但会用一对三个引号( ………………………… )或( )括起来，不属于任何语句的内容都可以视为注释，这样的代码会被解释器忽略。因为这样的代码可以写多行，所以也叫多行注释。

　　统计软件

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

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

　　@文件函数描述：编程规范

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

　　@创始人：计量经济学服务中心微信微信官方账号编辑团队

　　@修改logo:2017年10月2日

　　@修改描述：

　　@修改日期：

　　精彩回顾

郑重声明：本文由网友发布，不代表盛行IT的观点，版权归原作者所有，仅为传播更多信息之目的，如有侵权请联系，我们将第一时间修改或删除，多谢。

相关文章阅读