V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
推荐学习书目
Learn Python the Hard Way
Python Sites
PyPI - Python Package Index
http://diveintopython.org/toc/index.html
Pocoo
值得关注的项目
PyPy
Celery
Jinja2
Read the Docs
gevent
pyenv
virtualenv
Stackless Python
Beautiful Soup
结巴中文分词
Green Unicorn
Sentry
Shovel
Pyflakes
pytest
Python 编程
pep8 Checker
Styles
PEP 8
Google Python Style Guide
Code Style from The Hitchhiker's Guide
0001110001011
V2EX  ›  Python

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

  •  
  •   0001110001011 · 2021-10-19 14:52:16 +08:00 · 2067 次点击
    这是一个创建于 892 天前的主题,其中的信息可能已经有所发展或是发生改变。

    比如:

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

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

    现在效果是这样

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

    python 小白, 求大佬指点

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


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

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

    docstring 使用特别的格式编写,然后如果你的编辑器能够支持的话就可以看到了
    shaohan0228
        7
    shaohan0228  
       2021-10-20 18:30:38 +08:00
    Ctrl + Q 是说快捷键么?
    0001110001011
        8
    0001110001011  
    OP
       2021-10-22 08:56:33 +08:00
    @bnm965321 谢谢 , 我学习学习.
    0001110001011
        9
    0001110001011  
    OP
       2021-10-22 08:57:33 +08:00
    @shaohan0228 啥 Ctrl + Q ? 啥意思
    llsquaer
        10
    llsquaer  
       2021-10-22 11:16:15 +08:00
    pycharm 自动就显示 注释了啊...你是把什么功能关了么 .只要按照 这个格式就没问题.
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   我们的愿景   ·   实用小工具   ·   2789 人在线   最高记录 6543   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 27ms · UTC 12:51 · PVG 20:51 · LAX 05:51 · JFK 08:51
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.