处理文档字符串中重复内容的好方法是什么?我有许多采用“标准”参数的函数,这些参数必须在文档字符串中进行解释,但是最好只编写文档字符串的相关部分一次,因为这会更容易维护和更新。我天真地尝试了以下方法:
arg_a = "a: a very common argument"
def test(a):
'''
Arguments:
%s
''' % arg_a
pass
但这不起作用,因为当我这样做时help(test)
我没有看到文档字符串。有没有好的方法可以做到这一点?
正如其他答案所说,您需要更改__doc__
函数对象的成员。一个好方法是使用一个装饰器来对文档字符串执行格式化:
def fixdocstring(func):
func.__doc__ = func.__doc__.replace('<arg_a>', 'a: a very common argument')
#(This is just an example, other string formatting methods can be used as well.)
return func
@fixdocstring
def test(a):
'''
Arguments:
<arg_a>
''''
pass
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)