可以在python 3中鍵入提示用於生成文檔字符串？

Question

我們所用蟒使用文檔字符串指示類型的功能參數：

def f1(a): 
    """ 
    :param a: an input. 
    :type a: int 
    :return: the input integer. 
    :rtype: int 
    """ 
    return a 

對於f1，車博士生成以下文件：

fun1(a) 
    Parameters : a (int) – an input. 
    Returns : the input integer. 
    Return type: int 

在Python 3，其種類可以通過類型提示指示以及：

def f2(a: int): 
    """ 
    :param a: an input. 
    :return: the input integer. 
    :rtype: int 
    """ 
    return a 

當我們運行autodoc時，它通過參數聲明放入類型，但不是在de中scription：

f2(a: int) 
    Parameters : a – an input. 
    Returns : the input integer. 
    Return type: int 

是否可以使用註釋，而不是文檔字符串生成的文檔作爲f1？我正在使用python 3.6。謝謝！

Answer 1

還沒有，從我所知道的獅身人面像尚不支持這一點。評論中引用的錯誤是關於類型提示的表示，而不是它們的定位。

我知道目前有一個獅身人面像的擴展，爲您照顧，雖然叫做sphinx-autodoc-typehints。你可以暫時使用它。