文档字符串的数据？

StackOverflow https://stackoverflow.com/questions/197387

  •  10-07-2019
  •  | 
  •  

题

有一种方式来描述该文档字符串描述的模块或一个函数，以类似的方式在模块的数据？

class MyClass(object):
    def my_function():
        """This docstring works!"""
        return True
    my_list = []
    """This docstring does not work!"""
有帮助吗？

解决方案

据我所知，这是不可能分配文档字符串到模块的数据成员。

PEP 224 表明此功能，但该PEP被拒绝。

建议你记录一个模块的模块的文档字符串数据成员：

# module.py:
"""About the module.

module.data: contains the word "spam"

"""

data = "spam"

其他提示

它的是能够使模块的数据的文档，与使用的 epydoc的句法。 epydoc的是最频繁使用的文档的工具用于Python之一。

用于记录的语法是#:变量初始化线之上，如下所示：

# module.py:

#: Very important data.
#: Use with caution.
#: @type: C{str}
data = "important data"

现在，当您产生文档，data将被描述为与给定的描述模块变量并键入str。可以省略@type线。

作为codeape解释，这是不可能的记录一般的数据成员。

然而，它的是可能记录property数据成员：

class Foo:
  def get_foo(self): ...

  def set_foo(self, val): ...

  def del_foo(self): ...

  foo = property(get_foo, set_foo, del_foo, '''Doc string here''')

这会给出一个文档字符串到foo属性，很明显。

许可以下： CC-BY-SA 和 归因
不隶属于 StackOverflow
scroll top