标签:注意 nump groups param hat nal 经验 string int
成功的法则极为简单,但简单并不代表容易。
name = ‘xiaohong‘ # 单行注释
# 单行注释
name = ‘xiaohong‘
‘‘‘
这是使用三个单引号的多行注释
‘‘‘
"""
这是使用三个双引号的多行注释
"""
文档字符串
是一个重要工具,用于解释文档程序,帮助你的程序文档更加简单易懂
在函数体的第一行使用一对三个单引号 ‘‘‘ 或者一对三个双引号 """ 来定义文档字符串。你可以使用 doc(注意双下划线)调用函数中的文档字符串属性。
编写示例如下:
def add(num1,num2):
""" 完成传入的两个数之和
:param num1: 加数1
:param num2: 加数2
:return: 和
"""
return num1 + num2
print( add.__doc__ )
备注:DocStrings 文档字符串使用惯例:它的首行简述函数功能,第二行空行,第三行为函数的具体描述。
这是现在流行的一种风格,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
"""
"""
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 returned
Raises:
KeyError - raises an exception
"""
"""
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‘
Returns
-------
string
a value in a string
Raises
------
KeyError
when a key error
OtherError
when an other error
"""
标签:注意 nump groups param hat nal 经验 string int
原文地址:https://www.cnblogs.com/dream66/p/12826947.html