Python равнозначен блокам PHPDoc?
Я новичок в Python, пришедший из PHP, я знаю, что в Python есть строки документации, но как я могу это сделать с переменными класса? Допустим, в 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
Решение
Они называются «строки документации атрибутов». Вы можете поместить строку документации после объявления класса или в __init__ метод:
От ОПТОСОЗ 257:
Строковые литералы, встречающиеся сразу после простого присваивания
верхний уровень модуля, класса или в этом метод называется «атрибут
строки документации».
(смотрите также ОПТОСОЗ 258).
Об этом много ресурсов, просто ищите «строки атрибутов», например, этот ответ.
Другие решения
Других решений пока нет …