docstring

    0熱度

    2回答

    我正在Eclipse上使用PyDev,並且出於某種原因,當我將鼠標懸停在某個函數上時,它不顯示文檔字符串。什麼也行不通,是按F3鍵跳到功能。這兩個功能都可以在我的同事的電腦上工作。我們在同一個項目中嘗試了相同的功能。 我們在Preferences - > PyDev - > Editor - > Hover中比較了我們的設置,它們看起來很像。 我們都使用Eclipse 4.6.2和PyDef 5.

    1熱度

    1回答

    我正在使用Sphinx從我的docstrings中生成我的HTML文檔,比如一個好的'Pythonista'。 我有一個文檔字符串看起來像這樣: def do_a_thing(text): ''' Call the ``str.strip()`` method on ``text``. Then do something else with it. '''

    0熱度

    1回答

    我想要在sphinx中包含乳膠文檔。 sphinx html build不包括使用.. raw:: latex指令鏈接的乳膠文件。我已經 這是我的目錄結構 docs/ source/ importlatex.rst index.rst build/ tex/ texfile.tex index.rst看起來像 Welcome

    1熱度

    1回答

    我已經使用這個奇怪的語法了很長一段時間了,並且正在相當擅長它。 這就好像是關於java的一部分,並在Python中使用它。這很棒,我喜歡它,因爲註釋,我的IDE甚至發現了一些錯誤。 然而,我不知道誰指定了這個語法,它是多麼的官方,我不知道它的確切規則。 無可否認,我使用的是PyCharm,但我不知道這是否可以在其他IDE中使用,或者它只是PyCharm語法 - 我不想這樣想,而且我想使用也適用於其

    1熱度

    1回答

    我有幾個函數(a,b和c),我希望他們使用相同的文檔字符串。所以我的計劃是通過只寫一次文檔字符串並將其保存到變量DOCSTRING來保存行。然後我將它放在函數聲明下。我沒有發現任何在PEP 257,解決我的問題...... DOCSTRING = ''' This is a docstring for functions: a, b, c''' def a(x, y): D

    0熱度

    1回答

    在spyder IDE中,可以在實例化類時調出ctrl+i以調出與該類關聯的文檔字符串。 jupyter notebook中有類似的功能嗎?

    3熱度

    2回答

    我想添加一些支持自動完成到我的Python代碼Jedi。這可以通過使用函數文檔字符串或類型提示(或兩者)來完成。 def function_with_types_in_docstring(param1, param2): """Example function with types documented in the docstring. :type param1: int

    2熱度

    1回答

    我正在編寫一個需要調用腳本的文檔字符串的模塊。到目前爲止,我已成功使用 ​​ 文檔字符串都可以使用__doc__調用腳本中可以找到獲取調用腳本的文件名。然而,從被調用的腳本獲取文檔字符串似乎並不重要。當然,我可以編寫一個函數,但這肯定會忽略一些不常見的情況。我有一種方法來實際解析調用腳本以查找其文檔字符串(不執行其代碼)?

    5熱度

    1回答

    我想爲Python使用Google樣式文檔字符串。我已指定Pycharm應該期待谷歌文檔字符串: 出於某種原因,PyCharm不會顯示我的文檔字符串工具提示: 我在這裏引用的示例,正確的Google文檔字符串格式:http://www.sphinx-doc.org/en/stable/ext/example_google.html 我不清楚爲什麼PyCharm沒有顯示我的文檔字符串。

    1熱度

    1回答

    我使用Google風格的文檔字符串與sphinx.ext.autodoc自動生成我的函數的文檔,並確保它們在代碼中正確自我記錄。 我有一個函數def myfunc(id=None, size=None, hash=None),基於id或size + hash返回信息。如果我們有id作爲參數,則不需要size和hash,如果我們有size和hash作爲參數,則不需要id。 使用sphinx,可以指定