Python中注释规范代码的案例分析 - 行业资讯 - 肥雀云

　　介绍

小编给大家分享一下Python中注释规范代码的案例分析,相信大部分人都还不怎么了解,因此分享这篇文章给大家参考一下,希望大家阅读完这篇文章后大有收获、下面让我们一起去了解一下吧!

行注释:在符号后那一行不会被编译(显示)

块注释:被块注释符号中间的部分不会被编译

Python中使用#表示单行注释。单行注释可以作为单独的一行放在被注释代码行之上,也可以放在语句或表达式之后。如下例子:

名称=& # 39;北京市# 39;#单行注释

#单行注释
name=& # 39;北京市# 39;

Python中使用三个单引号或三个双引号表示多行注释。用在注释多写不下的情况,如下例子:
& # 39; & # 39; & # 39;
这是使用三个单引号的多行注释
& # 39; & # 39; & # 39;

“““
这是使用三个双引号的多行注释
“““

4.1文档字符串介绍

文档字符串

是一个重要工具,用于解释文档程序,帮助你的程序文档更加简单易懂

4.2 Python中使用文档字符串

在函数体的第一行使用一对三个单引号& # 39;& # 39;& # 39;或者一对三个双引号“““来定义文档字符串。你可以使用doc(注意双下划线)调用函数中的文档字符串属性。

编写示例如下:
 def添加(num1, num2):
　　“““完成传入的两个数之和
　　
　　:param num1:加数1
　　:param num2:加数2
　　返回:和
　　“““
　　返回num1 + num2
　　
　　打印(add.__doc__) 
备注:文档字符串文档字符串使用惯例:它的首行简述函数功能,第二行空行,第三行为函数的具体描述。

5.1其他风格

这是现在流行的一种风格,其他风格,斯芬克斯的御用格式,比较紧凑。
“““ 　　这是一个reST风格。　　　　:param param1:这是第一个参数　　:param param2:这是第二个参数　　返回:返回的是什么这是一个描述　　:提出了keyError:提出了一个例外　　“““
5.2谷歌风格

“““ 　　这是一组文档风格。　　　　参数: 　　param1——这是第一个参数　　param2——这是第二个参数　　　　返回: 　　这是一个描述返回的是什么　　　　提出了: 　　KeyError——提出了一个例外　　“““
5.3 Numpydoc (Numpy风格)

“““ 　　我的一种numpydoc描述　　的exhautive numpydoc docstring格式。　　　　参数　　---------- 　　第一:array_like 　　第一个参数名称“第一” 　　第二: 　　第二个参数　　第三:{& # 39;价值# 39;& # 39;其他# 39;},可选的　　第三个参数,默认情况下& # 39;价值# 39; 　　　　返回　　------- 　　字符串　　一个值在一个字符串　　　　提出了　　------ 　　KeyError 　　当一个关键错误　　OtherError 　　当另一个错误　　“““

<李>注释不是越多越好。对于一目了然的代码,不需要添加注释。 <李>对于复杂的操作,应该在操作开始前写上相应的注释。 <李>对于不是一目了然的代码,应该在代码之后添加注释。 <李>绝对不要描述代码。一般阅读代码的人都了解Python的语法,只是不知道代码要干什么李

以上是Python中注释规范代码的案例分析的所有内容,感谢各位的阅读!相信大家都有了一定的了解,希望分享的内容对大家有所帮助,如果还想学习更多知识,欢迎关注行业资讯频道!
Python中注释规范代码的案例分析