PyCharm 中可以在新建文件自動生成文件頭註釋,實現自動生成運行環境,作者、日期等必要信息,使用比較方便,配置十分簡單,具體設置可參考這篇博客。
另外,PyCharm在定義函數之後,可以自動生成包括參數和返回值在內的註釋,具體使用方法爲1:
- 函數定義後,另起一行,輸入三個引號(單引號和雙引號均可),後回車。
def f(b,c):
'''
- 結果爲:
def a(b,c):
'''
:param b:
:param c:
:return:
'''
但是,筆者發現,有一次安裝後,定義函數之後不能按照此方法自動生成註釋。查閱資料發現,原來是 PyCharm 的設置問題,設置方法如下2:
按照如上1-4的步驟,即在 File | Settings | Tools | Python Integrated Tools | Docstring format
中將 Docstring format
改爲 reStructuredText
,此處如果是 plain
就導致定義函數之後不能自動生成註釋。