PyCharm文檔注釋(docstrings)

一、問題描述

在編寫功能函數時，需要對函數的功能以及變量進行注釋，方便使用函數方法的人能迅速了解該方法的功能及使用方法。比如：

而注釋格式有多種，pycharm提供了五種模板，如圖：

二、docstrings模板設置

docstrings模板設置為：setting--->Tools--->python integrated Tools,如圖：

具體使用的方式就是在每個方法的下面連續輸入兩個三引號（""" """）就可以自動彈出模板。

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

三、效果展示

1、Plain

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

2、Epytext

3、reStructuredText

4、NumPy

5、Google