天天看點

pycharm建立py檔案之後,使用快捷鍵自動生成函數注釋

pycharm建立py檔案之後,使用快捷鍵自動生成函數注釋

問題描述——pycharm裡面如何生成函數注釋,如下面這樣

pycharm建立py檔案之後,使用快捷鍵自動生成函數注釋

問題原因

需要到pycharm裡面去設定一下

pycharm建立py檔案之後,使用快捷鍵自動生成函數注釋

解決方法

安裝上面進入pycharm設定裡面

如果這裡是reStructuredText的話,需要先改成其他的選項

pycharm建立py檔案之後,使用快捷鍵自動生成函數注釋

​一定要注意​

​​,在3個單引号或者3個雙引号的前面,有一個tab鍵的空間,就是python文法裡一個縮進。​

​我之前就是沒有加tab就一直沒有出來自動生成的代碼注釋​

​ 然後再按Enter鍵即可

pycharm建立py檔案之後,使用快捷鍵自動生成函數注釋

pycharm裡面自帶的有四種代碼注釋的風格:

1.Epytext

def func(a, b, c):
    """
  
    @param a:
    @param b:
    @param c:
    @return:
    """      

2.restructedText

def func(a, b, c):
    """
  
    :param a: 
    :param b: 
    :param c: 
    :return: 
    """      

3.Numpy

def func(a, b, c):
    """
  
    Parameters
    ----------
    a
    b
    c

    Returns
    -------

    """      
def func(a, b, c):
    """
  
    Args:
        a: 
        b: 
        c: 

    Returns:

    """