PyCharm 不能自動生成函數註釋

PyCharm 中可以在新建文件自動生成文件頭註釋,實現自動生成運行環境,作者、日期等必要信息,使用比較方便,配置十分簡單,具體設置可參考這篇博客

另外,PyCharm在定義函數之後,可以自動生成包括參數和返回值在內的註釋,具體使用方法爲1

  1. 函數定義後,另起一行,輸入三個引號(單引號和雙引號均可),後回車。
def f(b,c):
'''
  1. 結果爲:
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 就導致定義函數之後不能自動生成註釋。


  1. pycharm使用筆記3-自動生成文件註釋和函數註釋 ↩︎

  2. 請問PyCharm有沒有可以自動生成函數註釋的插件? - 宇總啥都不懂的回答 - 知乎 ↩︎

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章