PyCharm文档注释(docstrings)

PyCharm文档注释(docstrings)

一、问题描述

在编写功能函数时，需要对函数的功能以及变量进行注释，方便使用函数方法的人能迅速了解该方法的功能及使用方法。比如：

而注释格式有多种，pycharm提供了五种模板，如图：

二、docstrings模板设置

docstrings模板设置为：setting--->Tools--->python integrated Tools,如图：

具体使用的方式就是在每个方法的下面连续输入两个三引号（""" """）就可以自动弹出模板。

每种模板的展示效果如下：

三、效果展示

1、Plain

空白模板，也就是什么也没有

2、Epytext

3、reStructuredText

4、NumPy

5、Google