如何解决如何自动生成包含嵌套函数的文档字符串?
如何为 c_nested
函数自动生成文档?
背景:我为其他开发人员编写代码文档,我想自动生成包含带有简短描述(文档字符串)的嵌套函数的所有类方法的摘要。
当我在 help(A)
课上运行 A
时,我得到:
Help on class A in module __main__:
class A(builtins.object)
| A(a)
|
| doc A
|
| Methods defined here:
|
| __init__(self,a)
| Initialize self. See
|
| b_method(self)
| doc b_method
请求的输出:c_nested()
with docstring:(文档可以用脚本打印事件,不需要用 pydoc 帮助打印。)
Help on class A in module __main__:
class A(builtins.object)
| A(a)
|
| doc A
|
| Methods defined here:
|
| __init__(self,a)
| Initialize self. See
|
| b_method(self)
| doc b_method
|
| c_nested()
| doc c_nested
类示例:
class A:
""" doc A """
def __init__(self,a):
self.a = a
def b_method(self):
""" doc b_method """
def c_nested():
"""doc c_nested """
pass
return c_nested()
解决方法
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。