Python等价于PHPDoc块？

Question

我是来自PHP的Python新手，我知道Python具有Docstrings，但是如何在类变量上执行此操作？ 假设在PHP中，我有：

class Animal {
    /**
     * @var Noise
    */
    public $noise
}

现在我将如何实现这是python？ 就像是：

class Animal:
  # Here I want to tell my IDE that this is a noise object, not yet set
  self.noise = None

Answer 1

这些称为“属性文档字符串”。 您可以将docstring放在类的声明之后或__init__方法中：

从PEP 257 ：

在模块，类或init方法的顶级进行简单分配后立即出现的字符串文字称为“属性docstrings”。

（另请参阅PEP 258 ）。

有很多资源，只需搜索“属性docstrings”，例如this answer 。