在PyCharm中更改reStructuredText格式以获取自动生成的注释

Question

JetBrains的文档说，有两种格式可用于创建reStructuredText comments with type-hinting：

:param param_type param_name: parameter description (type description is on the same line as the parameter description).
:type param_name: param_type (type description is on a separate line)

以前有一种方法，如何选择一种或另一种方式来生成注释，但我无法在PyCharm 2017.1.2中找到该设置。任何想法，这个设置去了哪里？

我想在同一行中输入类型描述param_type，但标准方式将其放在下一行。

Answer 1

它在“设置”中 - ＆gt;工具 - ＆gt; Python集成工具 - ＆gt; Docstrings - ＆gt;文档格式。

如果我理解正确的格式，那就是NumPy格式。

此外，如果您使用的是Python＆gt; = 3.5，您可能已经知道变量和函数参数中的类型提示，这些提示看起来非常整洁，并在文档字符串中节省空间：https://docs.python.org/3/library/typing.html

狮身人面像支持他们之一：

• https://github.com/agronholm/sphinx-autodoc-typehints
• https://github.com/nicolashainaux/sphinx-autodoc-annotation