Я хочу аннотировать параметр типа для моего общего класса данных с помощью строки документации в стиле Google, чтобы поддерживать создание документации
и наведение мыши в VS Code (и других редакторах/IDE). Если я использую строки документации в стиле numpy, кажется, что это работает при наведении курсора мыши, однако когда я пытаюсь использовать стиль Google, это не работает. До сих пор я нашел очень мало документации о том, как аннотировать параметр типа с помощью строк документации в стиле Google, и самое близкое, что я нашел, это:
Код: Выделить всё
@final
@dataclass(frozen=True)
class MyDataclass[T]:
"""
A generic frozen dataclass.
Type Parameters:
T: A type parameter for this dataclass.
Attributes:
attribtue (str): This dataclass's `string` attribute.
"""
attribute: str
Я просто хочу знать, действительно ли это правильно или строки документации Google вообще поддерживают параметры типа аннотаций.
Подробнее здесь:
https://stackoverflow.com/questions/798 ... -parameter