PyCharm 提供了用于创建文档注释的便捷功能。
源代码中的文档注释可用于代码参考信息,并在按下 时打开以供查看Ctrl+Q。
可以根据语法创建文档注释,在项目设置 ( ) 的Python 集成工具Ctrl+Alt+S页面中选择,例如reStructuredText或epytext。
>
如果此功能适用于函数,PyCharm 会根据所选的文档字符串格式生成标签,例如:
对于 reStructuredText::param
函数签名中声明的每个参数的标记和:return
标记。
对于 epytext:@param
函数签名中声明的每个参数的标签,以及@return
标签。
reStructuredText和epytext标记中的标签相应地突出显示。
如果已配置,则可以使用type
和rtype
标记生成文档注释存根。
在 Python 文件中,PyCharm 识别表示为Python 文档字符串的文档注释。
在开始之前,请确保在 Settings/Preferences 对话框的Python Integrated Tools页面中选择了所需的文档字符串格式,例如epytext
或。reStructuredText
另请注意,PyCharm 从conf.py捕获自定义角色。配置包含*.rst文件的目录时,指向带有conf.py的目录(Python Integrated Tools | Path to the directory with *.rst files)。