Какой стиль PyCharm/IntelliJ использует для строк документации Python?

Я пытаюсь понять «экосистему решений» в отношении создания строк документации, а затем создания хорошей справочной документации с помощью PyCharm/IntelliJ.

Я привык к строкам документации в стиле Google, и меня смущает формат/стиль скелета строки документации PyCharm по умолчанию:

"""
:param <paramname>: blah blah
:return None
"""

Что это за стиль и с какими генераторами справочных документов он работает? Есть ли где-нибудь руководство по стилю?


person conner.xyz    schedule 21.09.2017    source источник
comment
Это reStructuredText стиль строки документации. Этот стиль указан в PEP 287.   -  person Cory Kramer    schedule 21.09.2017


Ответы (1)


Это строки документа в стиле Sphinx.

У Python есть твердые мнения о строках документов, см. PEP257.

Вот полное описание всех типов строк документа в Python: Что такое стандартный формат строки документации Python?

person townie    schedule 21.09.2017