php - 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方法的顶层进行简单赋值后立即出现的字符串文字称为“属性文档字符串”。

（另见PEP 258）。

这方面有很多资源，只需搜索“属性文档字符串”，例如，这个答案。