首页 > 编程语言 >Python文档字符串设置--在PyCharm中

Python文档字符串设置--在PyCharm中

时间:2024-04-08 22:56:18浏览次数:28  
标签:下面 Python -- 文档 设置 字符串 PyCharm

引言

在PyCharm中,只要我们在一个函数下面输入一个三引号"""并回车,PyCharm会自动帮我们补全文档字符串,如下图所示:

image

然而,有些小伙伴的pycharm却无法实现这种功能,接下来我会讲一下,如何在PyCharm中设置,让PyCharm自动生成我们想要的文档字符串。

PyCharm文档字符串种类

种类如下所示:
image

一共五种,接下来分别看看这些文档字符串都长什么样吧!

第一种:Plain

这种其实是什么也没有,PyCharm不会自动帮我们补全。

image

第二种:Epytext

Epytext是下面这样的:

image

第三种:reStructuredText

reStructuredText是下面这样式的:

image

第四种:NumPy

NumPy是下面这样式的:

image

第五种:Google

Google是下面这样式的:

image

在PyCharm如何设置呢?

设置方式也很简单,按照下面这个路径找就行:

File -> Settings... -> Tools -> Python Integrated Tools,然后在Docstrings下面的Docstring中选择自己喜欢的即可。

具体步骤如下图:

image

image

image

image

进一步设置

我们还可以在Editor > General > Smart Keys > Python勾选

image

看看效果

第一种:Plain

image

第二种:Epytext

image

第三种:reStructuredText

image

第四种:NumPy

image

第五种:Google

image

大家发现经过我们进一步的设置,能够更清晰地展现出我们参数的数据类型,是不是很不错呢?

写在最后

每个人都有每个人的喜好,你喜欢什么样的风格呢?评论区聊一下吧!

如果感觉这篇文章对你有用,那么请不要吝惜你手中的点赞哦,爱你哟。image

标签:下面,Python,--,文档,设置,字符串,PyCharm
From: https://www.cnblogs.com/wephilos/p/18122767

相关文章

  • 时间戳转换日期格式
    1、时间戳入参String类型importjava.text.DateFormat;importjava.text.SimpleDateFormat;//毫秒时间戳转换日期格式:2023-04-21defdate=newDate(Long.parseLong("1712473439000"));//需要转LongDateFormatdateFormat=newSimpleDateFormat("yyyy-MM-dd");def......
  • 计算机网络第一章--概述
    第一章概述1.1计算机网络的主要功能计算机网络的主要功能有①数据通信。数据通信是计算机网络最基本的功能。②资源共享。资源是指网络中所有的硬件、软件和数据资源。③分布式处理。对于一些大型任务,可把它分解成多个小型任务,由网络上的多台计算机协同工作、分布式处理。......
  • XML文档节点导航与选择指南
    XPath(XMLPathLanguage)是XSLT标准的主要组成部分。它用于在XML文档中浏览元素和属性,提供了一种强大的定位和选择节点的方式。XPath的基本特点代表XML路径语言:XPath是一种用于在XML文档中导航和选择节点的语言。路径样式语法:XPath使用路径表达式的“路径样式”语法来......
  • playwright-异步模式
    #异步模式importasynciofromplaywright.async_apiimportasync_playwright#导入异步模块asyncdefmain():#封装一个特殊函数#创建一个Playwright的管理器对象asyncwithasync_playwright()asp:#等同于p=sync_playwright()#基于p创建一个浏览器......
  • C++ 入门一
    C++入门一1.C++关键字2.命名空间2.1命名空间定义2.2命名空间使用3.C++输入&输出C++是一种高级编程语言,由BjarneStroustrup在20世纪80年代初期在贝尔实验室开发。它是对C语言的扩展,添加了面向对象编程的特性,如类和对象、继承、多态和封装。C++支持多种编程范式,......
  • Linux 软件包管理器yum
    一、yum概念yum是一个软件包管理器,相当于手机上的应用商店。Linux系统中的软件包可能会存在依赖关系,下载软件A,可能会需要同时下载文件B、C、D,但是yum会帮我们解决这些软件包之间的依赖关系。2.yum的生态Linux系统中有三种下载软件的方式:源代码安装、rpm包安装、yum安装源......
  • Unity性能优化-C#篇
    Unity性能优化-C#篇 1.UnityAPI GameObject.GetComponentUnity是基于组件的开发方式,所以GetComponent是一个高频使用的函数每次调用GetComponent时,Unity都要去遍历所有的组件来找到目标组件每次都去查找是不必要的耗费,可以通过缓存的方式来避免这些不必要的开销其中......
  • Datacom HCIP笔记-MPLS协议 之一
    MPLS标签放在二层头和IP头之间可以称之为2.5层的位置LSP(LabelSwitchedPath):标签交换路径,艮即到达同一目的地址的报文在MPLS网络中经过的路径。FEC(ForwardingEquivalentClass):一般指具有相同转发处理方式的报文。在MPLS网络中,到达同一目的地址的所有报文就是一个FEC。......
  • ES入门十二:相关性评分
    对于一个搜索引擎来说,对检索出来的数据进行排序是非常重要的功能。全文本数据的检索通常无法用是否相等来的出结果,而是用相关性来决定最后的返回结果相关性是值搜索内容和结果的相关性,是用来描述文档和查询语句的匹配程度的。通过计算相关性,可以得出一个相关性评分,然后根据......
  • centos 安装 jenkins
    1.下载war包。注意:需要JDK11版本及以上  https://mirrors.tuna.tsinghua.edu.cn/jenkins/war-stable/2.426.1/jenkins.war2.启动jenkinsjava-jarjenkins.war--httpPort=75003.访问http://localhost:7500,一直下一步。4.新建一个自由风格配置  5.配置shell  注......