opacity visibility displaypython编程100例带注释-Python代码注释规范代码实例解析⼀、代码注释介绍
注释就是对代码的解释和说明，其⽬的是让⼈们能够更加轻松地了解代码。
注释是编写程序时，写程序的⼈给⼀个语句、程序段、函数等的解释或提⽰，能提⾼程序代码的可读性。
在有处理逻辑的代码中，源程序有效注释量必须在20％以上。
⼆、代码注释分类
⾏注释：在符号后那⼀⾏不会被编译（显⽰）
块注释：被块注释符号中间的部分不会被编译
三、python代码注释基础
Python中使⽤#表⽰单⾏注释。单⾏注释可以作为单独的⼀⾏放在被注释代码⾏之上，也可以放在语句或表达式之后。如下例⼦：
name = 'xiaohong' # 单⾏注释
# 单⾏注释
name = 'xiaohong'
Python中使⽤三个单引号或三个双引号表⽰多⾏注释。⽤在注释多写不下的情况，如下例⼦：
'''
这是使⽤三个单引号的多⾏注释
'''
"""
这是使⽤三个双引号的多⾏注释
"""
四、DocStrings介绍与使⽤
4.1 DocStrings介绍
⽂档字符串
是⼀个重要⼯具，⽤于解释⽂档程序，帮助你的程序⽂档更加简单易懂
4.2 python中使⽤DocStrings
在函数体的第⼀⾏使⽤⼀对三个单引号 ''' 或者⼀对三个双引号 """ 来定义⽂档字符串。你可以使⽤ doc（注意双下划线）调⽤函数中的⽂档字符串属性。
编写⽰例如下：
def add(num1,num2):
""" 完成传⼊的两个数之和
:param num1: 加数1
:param num2: 加数2
:return: 和
"""
return num1 + num2
print( add.__doc__ )
备注：DocStrings ⽂档字符串使⽤惯例：它的⾸⾏简述函数功能，第⼆⾏空⾏，第三⾏为函数的具体描述。
五、DocStrings常⽤编写风格
5.1 reST风格
这是现在流⾏的⼀种风格，reST风格，Sphinx的御⽤格式，⽐较紧凑。
"""
This is a reST style.
电动机怎么改变转矩
:param param1: this is a first param
:param param2: this is a second param
:returns: this is a description of what is returned
:raises keyError: raises an exception
"""
5.2 Google风格
"""
This is a groups style docs.
Parameters:
param1 - this is the first param
param2 - this is a second param
Returns:
This is a description of what is returnedservice标致
Raises:
KeyError - raises an exception
"""
5.3 Numpydoc (Numpy风格)
"""
My numpydoc description of a kind
of very exhautive numpydoc format docstring.
Parameters
----------
first : array_like
the 1st param name `first`
second :
the 2nd param
third : {'value', 'other'}, optional
the 3rd param, by default 'value'
c语言while函数用法
Returns
-------
string
a value in a string
Raises
------python基础代码100例
KeyError
when a key error
OtherError
when an other error
"""
六、⼀些注释经验
注释不是越多越好。对于⼀⽬了然的代码，不需要添加注释。
对于复杂的操作，应该在操作开始前写上相应的注释。
对于不是⼀⽬了然的代码，应该在代码之后添加注释。
绝对不要描述代码。⼀般阅读代码的⼈都了解Python的语法，只是不知道代码要⼲什么
tableservice以上就是本⽂的全部内容，希望对⼤家的学习有所帮助，也希望⼤家多多⽀持python博客。

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。