pycharm 如何智能提示出 方法内的 行内注释??

2021-10-19 14:52:16 +08:00
 0001110001011

比如:

def plot( data, **kwargs ):
    """
    Given a Pandas DataFrame containing columns Open,High,Low,Close and optionally Volume
     
    """

因为注释里面会包含很多参数的信息一类的,比如 kwargs 这种

现在效果是这样

怎么设置才能打参数的时候,显示文档呢?

python 小白, 求大佬指点

2222 次点击
所在节点    Python
10 条回复
Eiden
2021-10-19 18:38:40 +08:00
zzm88104
2021-10-19 18:46:22 +08:00
用 kite?
skinny
2021-10-19 19:29:55 +08:00
我也遇到相似的问题,我不知道 Pycharm 为什么能识别 requests 之类库函数的 kwargs 参数里的具体参数的注释(比如参数就一个**kwargs,但是在注释里用:param 指令写具体参数注释),但是在我自己的代码里相同格式的注释却不能识别,甚至我直接复制 requests 库函数的注释出来测试,它都不能识别,还提示注释不规范。
0001110001011
2021-10-20 01:48:52 +08:00
@zzm88104 kite 也不行。


@Eiden 大佬这个 图 有什么深得意义吗?
0001110001011
2021-10-20 01:51:00 +08:00
@Eiden @zzm88104 @skinny

我测试了 vsocde,和 spyder 都是可以的,但是用不习惯这 两个软件。 很是纠结。
bnm965321
2021-10-20 15:04:13 +08:00
https://stackoverflow.com/questions/3898572/what-is-the-standard-python-docstring-format

docstring 使用特别的格式编写,然后如果你的编辑器能够支持的话就可以看到了
shaohan0228
2021-10-20 18:30:38 +08:00
Ctrl + Q 是说快捷键么?
0001110001011
2021-10-22 08:56:33 +08:00
@bnm965321 谢谢 , 我学习学习.
0001110001011
2021-10-22 08:57:33 +08:00
@shaohan0228 啥 Ctrl + Q ? 啥意思
llsquaer
2021-10-22 11:16:15 +08:00
pycharm 自动就显示 注释了啊...你是把什么功能关了么 .只要按照 这个格式就没问题.

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/808890

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX