Question

在类中记录静态变量的首选方法是什么？

class Foo(object):
    """
    Foo doc.
    """

    bar = 'bar'
    """
    Bar doc.
    """


class Foo(object):
    """
    Foo doc.
    """

    # Bar doc.
    bar = 'bar'

别的......？

Answer 1

无法将文档字符串与变量相关联。 PEP添加属性文档字符串失败。

代码文档的最佳方式可能是注释而不是文档字符串，因此您不会引入PEP讨论的类型的模糊性。如果您需要在help()和docs中，还可以在课程'docstring中记录它们。

Answer 2

Epydoc文档工具确实支持变量doc字符串：

http://epydoc.sourceforge.net/manual-docstring.html#variable-docstrings

格式如上所述：

如果变量赋值语句后面紧跟一个裸字符串文字，那么该赋值将被视为该变量的文档字符串

Answer 3

我个人使用Google风格的DocString格式，而我对静态属性的处理方法是将其包含在类的DocString中。

例如

class Bicycle:
    """
    A class defining a Bicycle

    Attributes:
        NUM_WHEELS (int): The number of wheels that a bicycle has: 2.
    """
    NUM_WHEELS = 2

这绝对是一个自以为是的话题。根据您希望属性的可见程度，也可以仅使用属性定义上方的常规注释来记录它们。例如

class Bicycle:
    """
    A class defining a Bicycle
    """
    # The number of wheels that a bicycle has
    NUM_WHEELS = 2

如何正确记录课程＆＃39;静态变量？

3 个答案: