在python文档字符串中写入默认值的标准方法是什么?
我有一个参数设置为默认值的函数。我使用的是docstring,但我看到了其他地方编写的默认值。在docstring中写入“default”的常见位置是什么在python文档字符串中写入默认值的标准方法是什么?,python,numpy,docstring,Python,Numpy,Docstring,我有一个参数设置为默认值的函数。我使用的是docstring,但我看到了其他地方编写的默认值。在docstring中写入“default”的常见位置是什么 def some_func(a_num=None, a_string=None): ''' A function that does something special. Parameters ========== a_num : int, default 100
def some_func(a_num=None, a_string=None):
''' A function that does something special.
Parameters
==========
a_num : int, default 100 # is it written here?
An important number.
a_string : str, default 'foo'
A useful string. Default is 'foo'. # or here?
'''
如果您在链接的文档中进一步阅读,看起来没有一种标准样式: 可选关键字参数具有默认值,这些值显示为函数签名的一部分。它们也可以在描述中详细说明: 参数“x”的说明(默认值为-1,表示求和 在所有轴上)。 当参数只能采用一组固定值中的一个时,这些值可以用大括号列出,默认值首先出现:
顺序:{'C','F','A'}
“订单”的说明。
我建议您为自己的项目选择一种风格并坚持下去。我注意到了这一点。我想知道哪种风格更为普遍接受。特别是一个不干扰普通docstring解析器的。