pycharm如何為函數插入文檔註釋

Posted on by

pycharm為函數插入文檔註釋

S1 光標放在函數名上方，點擊小燈泡，出現菜單

S2 選擇 input documentation string stub ，即插入文檔註釋

在這裡插入圖片描述

S3 輸入函數的各參數註釋，返回值註釋

在這裡插入圖片描述

pycharm函數註釋簡單設置

在安裝PyCharm後可能存在函數自動註釋無法使用的情況。

可以按照以下路徑：File->Settings->Tools->Python Intrgrated Tools->Docstrings->Docstring format 進行修改

將Plain換為其他的任意模板，這裡使用Goole，當然也可以自己創建模板

Plain可能無法使用，可以選擇其他模板。推薦使用Google

修改後，在函數下方輸入三個 " 回車就會自動添加相應格式的註釋

'''
@Project : python
@File    : TEST
@Author  : [email protected]
@Data    : 2021/3/22 10:26
'''
def newfunc(a,b):
    """
    Args:
        a:
        b:
    Returns:
    """
    pass

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：