在PyDev中顯示函數文檔

我已經啓動並運行了Pydev，幾乎所有的工作都很好。不過，我在文檔上遇到了一些麻煩。在PyDev中顯示函數文檔

比方說，比如我有一個函數，如下列：

def _get_logging_statement(self): 
    """Returns an easy to read string which separates items in the log file cleanly""" 
    result = "\n\n#=============================================" 
    result += "\n# %-80s#"(self) 
    result =+ "\n\n#============================================" 
    return result

假設我已經覆蓋再版格式化該字符串適當爲好。

當我將其懸停在Eclipse中時，它會顯示完整的文檔字符串。但是，完整實現也顯示在doctsting下面。

有沒有辦法只有顯示文檔字符串？

來源

2010-12-15 Scott

注：我不希望把docstring放在執行的下面，因爲這似乎違背了PEP標準。 – Scott 2010-12-15 15:31:30

雙下劃線方法令人不愉快（它們導致函數的名稱被破壞，這會導致錯誤並且不會提供額外的安全性） - 在您自己的危險中使用！ – katrielalex 2010-12-15 15:36:24

從katrielalex開始，以* single *下劃線開頭避免了麻煩，並且仍然被認爲是'內部'按照慣例。 – 2010-12-15 17:09:43

看起來不像現在。用Google搜索周圍的這個問題和上面的結果向我指出這個Pydev-users post：

於星期一，2010年5月3，在上午5:45，賈尼奧斯奇彼得斯寫道：

嗨，

當我將鼠標懸停在某個函數或類上時，我得到一個工具提示，顯示函數/類的整個定義，不僅僅是文檔字符串（如I 所期望的）。

這是預期的行爲？我認爲它會更有用，如果只顯示文檔字符串的內容。

目前預計。請輸入功能請求以使僅顯示文檔字符串選項。

乾杯，

法比奧

看了看身邊的Pydev的錯誤/特徵跟蹤，並沒有發現這一具體問題進入。您可能想要將其輸入到Pydev功能請求跟蹤器中，並查看是否可以在那裏獲得幫助。

來源

2010-12-16 18:12:55 spade78

我已經提交了在PyDev bug tracker功能請求，ID爲863

在PyCharm當我將鼠標懸停到方法名，我可以看到顯示只有每一個方法的文檔字符串的彈出，沒有執行力細節。並且，標籤等@param xx:，@rtype等被正確解析和在彈出可讀的格式示出，並且不同的風格等 spinx/epytext /谷歌/純可以在設置中進行調整，以便它可以識別所有格式。

我想提出同樣的PyDev的：一個彈出窗口，顯示文檔字符串與解析標籤，沒有實施細則，如果喜歡的javadoc，可以使用<code>some code</code>以使其像HTML，效果更好。

如果您還想要這個票，可以考慮投票決定票。（也許在這裏也可以投票）

來源

2017-11-10 13:37:35 FaithReaper

在PyDev中顯示函數文檔

回答

相關問題