python中文编码注释,python 类注释规范
一、代码注释介绍
注释是对代码的解释和说明，目的是让人更容易理解代码。注释是编写程序的人对语句、程序段、函数等给出的解释或提示。编写程序时，这样可以提高程序代码的可读性。在有处理逻辑的代码中，源程序的有效注释量必须在20%以上。
相关学习推荐：python视频教程
二、代码注释分类
注意：符号后面的行将不被编译(显示)。
块：块注释符号中间的部分将不被编译。
三、python代码注释基础
#在Python中用于表示单行注释。单行注释可以作为单行放在被注释的代码行之上，或者放在语句或表达式之后。例子如下：
Name=小红 #单行注释
#单行注释
name=小红
Python使用三个单引号或三个双引号来表示多行注释。在写不出更多评论的情况下，下面这个例子：
这是一个多行注释，有三个单引号。
这是一个多行注释，有三个双引号。
四、DocStrings介绍与使用
4.1文档字符串介绍
文档字符串
它是解释文档程序的重要工具，有助于你的程序文档更加简单易懂。
4.2在Python中使用文档字符串
在函数体的第一行使用一对三个单引号或一对三个双引号 来定义文档字符串。您可以使用doc(注意双下划线)来调用函数中的文档字符串属性。
写一个例子如下：
定义添加(num1，num2):
“”完成传入的两个数的求和。
:param num1:加数1
:param num2:加2
:return:和
返回数字1数字2
打印(添加。__doc__)备注：DocStrings文档字符串使用约定：其第一行简要描述函数，第二行空白，第三行是行为函数的具体描述。
五、DocStrings常用编写风格
5.1休息方式
这是现在流行的风格，reST风格，斯芬克斯的皇家格式，比较紧凑。
这是一种休息方式。
:参数参数1:这是第一个参数
:参数参数2:这是第二个参数
:returns:这是返回内容的描述
:引发了一个异常
5.2谷歌风格
这是一个团体风格的文件。
参数：
param1 -这是第一个参数
param2 -这是第二个参数
返回：
这是对返回内容的描述
Raises:
引发一个异常
5.3 Numpydoc (Numpy样式)
我的一种数字描述
非常昂贵的numpydoc格式的文档字符串。
因素
-
第一个：数组_like
第一个参数名` first
第二个：
第二个参数
第三个： { 值，其他 }，可选
第三个参数，默认为“值”
返回
-
线
字符串中的值
举起
-
元素不存在
当一个键错误
其他错误
当另一个错误
六、一些注释经验
评论越多越好。对于一目了然的代码，不需要添加注释。对于复杂的操作，应该在操作开始之前编写相应的注释。对于不能自我解释的代码，应该在代码后面添加注释。千万不要描述代码。一般看代码的人都知道Python的语法，但是不知道代码要做什么。相关学习推荐：编程视频
以上是Python代码注释规范代码的详细内容。更多信息请关注盛行IT软件开发工作室的其他相关文章！
郑重声明：本文由网友发布，不代表盛行IT的观点，版权归原作者所有，仅为传播更多信息之目的，如有侵权请联系，我们将第一时间修改或删除，多谢。