pycharm的docstring多了一行type

本文为作者原创,转载请注明出处:https://www.cnblogs.com/zhaoqingqing/p/16512482.html



注释中多了一行:type#

设置为Epytext

PyCharm 2020.3.5 (Community Edition)

Copy
def test(param1,param2,param3): """ :param param1: :param param2: :param param3: :return: """

同样的函数在pycharm2021下,每个参数都有一行type用来标注数据类型

PyCharm 2021.2 (Professional Edition)

Copy
def test(param1,param2,param3): """ :param param1: :type param1: :param param2: :type param2: :param param3: :type param3: :return: :rtype: """

取消方法#

  1. Press and go to Editor | General |Smart Keys | Python.Ctrl+Alt+S

    unSelect the Insert type placeholders checkbox in the Smart Keys page of the editor settings.

编辑器 - 常规 - 智能键 - Python,取消勾选 【在文档注释存根中插入类型占位符】

类型放在同一行?#

官网提到可以把类型和param放在同一行,原文如下:https://www.jetbrains.com/help/pycharm/using-docstrings-to-specify-types.html#param-type-specification

请注意,对于 reStructuredText,可以用两种格式指定类型:

  • :param param_type param_name: parameter description(类型描述与参数描述位于同一行)。
  • :type param_name: param_type(类型说明位于单独的行上)

示例代码如下,但我没找到设置方法,我是手动写的,在按下Ctrl+Q出现方法提示中可以看到每个参数的数据类型

Copy
def seek( self, destination, timeout, verticalRange, callback ): """ 调用seek函数使实体移动到特定位置并偏航。它的运动速度包含在物理学的速度属性中。它转向目的地,并沿着直线移动,直到接近目的地,然后转向想要的偏航。如果它被几何体挡住了,它会一直尝试移动,直到超时。 :param self: :param vector4 destination: :param int timeout: :param int verticalRange: :param function callback: :return: """ pass

在文章中有这样一样方法

  1. Press and go to Build, Execution, Deployment | Python Debugger. In the Python Debugger page, select the Collect runtime information for code insight checkbox.Ctrl+Alt+S

构建、执行、部署 - Python调试器 - 勾选 【收集运行时类型信息以获取代码洞察】

我在本地这样测试是没有效果,可能是因为我们游戏代码在pycharm中并不能调试

Docstring不会发生改变?#

我在pycharm2021下修改Docstring风格不生效,因为切换风格后生成的注释都不会发生改变,比如Epytext,google。

目前还没找到是什么原因引起的。

docstrings是一门标记语言#

看了官方每一种docstrings的文档,了解到每一种注释风格都是一门标记语言

Legacy type syntax for docstrings | PyCharm (jetbrains.com)

作者:赵青青   一名在【网易游戏】做游戏开发的程序员,擅长Unity3D,游戏开发,.NET等领域。
本文版权归作者和博客园共有,欢迎转载,转载之后请务必在文章明显位置标出原文链接和作者,谢谢。
如果本文对您有帮助,请点击【推荐】您的赞赏将鼓励我继续创作!想跟我一起进步么?那就【关注】我吧。
posted @   赵青青  阅读(209)  评论(0编辑  收藏  举报
相关博文:
阅读排行:
· 10亿数据,如何做迁移?
· 推荐几款开源且免费的 .NET MAUI 组件库
· 清华大学推出第四讲使用 DeepSeek + DeepResearch 让科研像聊天一样简单!
· 易语言 —— 开山篇
· Trae初体验
历史上的今天:
2014-07-23 Collider Collision 区别
点击右上角即可分享
微信分享提示
CONTENTS