数据的文档字符串？

发布于 2024-07-07 00:09:34 字数 225 浏览 13 评论 0原文

有没有一种方法可以像文档字符串描述模块或函数一样来描述模块的数据？

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

原文

Is there a way to describe the module's data in a similar way that a docstring describes a module or a funcion?

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

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

ˉ厌 2024-07-14 00:09:34

使用 epydoc 语法可以对模块数据进行文档化。 Epydoc 是最常用的 Python 文档工具之一。

记录的语法是变量初始化行上方的 #:，如下所示：

# module.py:

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

现在，当您生成文档时，data 将被描述为具有给定描述和类型的模块变量 <代码>str。您可以省略 @type 行。

It is possible to make documentation of module's data, with use of epydoc syntax. Epydoc is one of the most frequently used documentation tools for Python.

The syntax for documenting is #: above the variable initialization line, like this:

# module.py:

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

Now when you generate your documentation, data will be described as module variable with given description and type str. You can omit the @type line.

回复收藏 0 原文

陈甜 2024-07-14 00:09:34

据我所知，不可能将文档字符串分配给模块数据成员。

PEP 224 建议使用此功能，但 PEP 被拒绝。

我建议您在模块的文档字符串中记录模块的数据成员：

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

module.data: contains the word "spam"

"""

data = "spam"

To my knowledge, it is not possible to assign docstrings to module data members.

PEP 224 suggests this feature, but the PEP was rejected.

I suggest you document the data members of a module in the module's docstring:

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

module.data: contains the word "spam"

"""

data = "spam"

回复收藏 0 原文

调妓 2024-07-14 00:09:34

正如 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 属性提供文档字符串。

As codeape explains, it's not possible to document general data members.

However, it is possible to document property data members:

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''')

This will give a docstring to the foo attribute, obviously.

回复收藏 0 原文

~没有更多了~