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

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

来自PEP 257：

  

在完成简单赋值后立即出现的字符串文字   模块，类或 init 方法的顶层称为“属性   docstrings”。

（另请参见PEP 258）。

有很多资源，只需搜索“属性文档字符串”，例如this answer。