在docstrings中动态生成文档是不好的做法

时间:2019-05-02 12:03:52

标签: python documentation definition docstring

说我有一个带有函数的类:

class Foo:
    def one():
        return 1
    def two():
        return 2
    def three():
        return 3
    def four():
        return 4

如果我想在__doc__上添加一个文档字符串(Foo),以显示所有功能,我可以分别写出每种方法:

class Foo:
    """
    one()
    two()
    three()
    four()"""

但是它也可以动态生成,即在运行时创建:

class Foo:
    def one():
        return 1
    def two():
        return 2
    def three():
        return 3
    def four():
        return 4

Foo.__doc__ = '()\n'.join(dir(Foo)) # __doc__ automatically list all methods with Foo (private and non private)

这也可能有其他用途。例如运行实际正在使用的功能的示例。

记录较大的模块的工作量较小,但这意味着__doc__的性能将降低(因为在成品中几乎不会使用它,因此我认为这不是问题),并且不再是常量字符串。

这被认为是不好的做法吗?

0 个答案:

没有答案