在eclipse中爲Python自動生成虛擬文檔

當我記錄了很多代碼（Python）時，我想知道是否有插件可以自動爲我的函數生成文檔字符串，像編寫///通過一個方法時，像C＃一樣的Visual Studio。在eclipse中爲Python自動生成虛擬文檔

我一直在尋找解決方案，但我沒有運氣 - 你們有沒有人知道解決方案？

例子：

從對「虛擬」的文件將在我的方法定義來創建一個方法我的參數列表如下圖所示：

def myFunction(self, a, b): 
    """ 

    :param a: 
    :type a: 
    :param b: 
    :type b: 
    :return: 
    :rtype: 
    """ 
    return 'Hello, world'

來源

2011-09-21 aweis

我認爲，總的來說，這與Python的精神相違背。參數應該通過可能的詳細名稱進行自我記錄。 Python使用類型推斷，因此，如果參數類型與預期的參數類型不匹配，則單元測試應該失敗。一行文檔就足夠了。 –

然而，在許多方面我都同意你的看法，但我並不認爲我的最終用戶就是這樣。他沒有權限訪問單元測試，我相信一個不錯的文檔代碼比我的參數名稱更加詳細，這讓他的生活更輕鬆，他可以更快地啓動和運行我的API。（並且花費更少） – aweis

我明白你的觀點，但我會放棄類型信息。 –

那麼，根據this doc，如果你按Ctrl + 上的方法名稱，你會得到你所需要的。

對於示例（編輯：如果您設置的選項的PyDev>編輯>代碼樣式>文檔字符串> Doctag一代總是讓帕拉姆的類型），您將獲得：

def myFunction(self, a, b): 
    ''' 

    @param a: 
    @type a: 
    @param b: 
    @type b: 
    ''' 
    return 'Hello, world'

來源

2011-09-21 13:47:46

我還沒有找到，但它非常接近:)我可以看到，在我的Eclipse偏好中，我可以將single-qoute更改爲double，但是由於我的文檔工具（Sphinx），'@'必須是變成'：'去工作，但我真的不知道這是否可能！ – aweis

@aweis：我發現如何添加參數的類型（還沒有如何將@更改爲:) –

嗨，一些我沒有這種類型，你做了什麼來獲得自動生成呢？ - 如果我也得到類型參數，我可以忍受這個事實，我需要手動更改@的 – aweis

在eclipse中爲Python自動生成虛擬文檔

回答

相關問題