我在弄清楚在Pycharm中记录方法的正确方法遇到麻烦,以实现类型提示和参数描述。
在Pycharm's documentation中,它建议:
(1)但是,当我尝试使用它时,函数定义不能正确显示参数说明:
(2)如果我切换到以@
符号开头,则会得到参数及其类型的列表,但没有得到参数说明:
(3)如果坚持使用@
符号并删除类型,则会得到参数说明:
(4)如果我为每个@type
显式添加@param
(这完全炸毁了注释块的大小),则一切正常(但我讨厌注释的大小):
(5)最后,出于完整性考虑,使用:
而不是@
会导致所有内容填充失败:
请注意,我已经尝试过更改Pycharm中的文档系统,但是它并不影响它如何呈现文档-似乎只影响它如何为您自动填充注释块。
如何获得接近示例(1)的紧凑文档,但实际上却正确地填充了函数定义?我不喜欢风格(4)。
最佳答案
您是否检查过设置...-工具-Python集成工具-Docstring格式?您可以选择解析样式。
您可以选择:
关于pycharm - 使用PyCharm在文档字符串中记录Python参数,我们在Stack Overflow上找到一个类似的问题:https://stackoverflow.com/questions/31796481/