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

引言

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

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

PyCharm文档字符串种类

种类如下所示：

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

第一种：Plain

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

第二种：Epytext

Epytext是下面这样的：

第三种：reStructuredText

reStructuredText是下面这样式的：

第四种：NumPy

NumPy是下面这样式的：

第五种：Google

Google是下面这样式的：

在PyCharm如何设置呢？

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

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

具体步骤如下图：

进一步设置

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

看看效果

第一种：Plain

第二种：Epytext

第三种：reStructuredText

第四种：NumPy

第五种：Google

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

写在最后

每个人都有每个人的喜好，你喜欢什么样的风格呢？评论区聊一下吧！

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