跳到内容

未文档化的公共嵌套类 (D106)

源自 pydocstyle 代码检查器。

作用

检查未文档化的公共类定义，适用于嵌套类。

为什么这不好？

公共类应该通过文档字符串进行文档化，以概述其目的和行为。

嵌套类不会继承其封闭类的文档字符串，因此它们应该有自己的文档字符串。

如果代码库遵循类文档字符串的标准格式，请遵循该格式以保持一致性。

示例

class Foo:
    """Class Foo."""

    class Bar: ...


bar = Foo.Bar()
bar.__doc__  # None

建议改为

class Foo:
    """Class Foo."""

    class Bar:
        """Class Bar."""


bar = Foo.Bar()
bar.__doc__  # "Class Bar."

参考