如何自动生成包含嵌套函数的文档字符串？
如何自动生成包含嵌套函数的文档字符串？
提问于 2021-01-23 14:02:36
如何自动生成c_nested函数的单据？
背景:我为其他开发人员编写代码文档，我希望自动生成包含简短描述(docstring)的嵌套函数的所有类方法的摘要。
当我在类A上运行help(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()：(文档可以通过脚本打印事件，不需要使用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()回答 1
Stack Overflow用户
发布于 2021-01-23 14:23:50
本地函数不是公开可见的，因此它们的文档字符串不会包含在帮助中。
如果希望该函数显示在帮助中，请使其成为模块级函数或类的方法。
另请参阅Are docstrings for internal functions (python) necessary?
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/65860067
复制相关文章
相似问题
腾讯云开发者
