![](/img/trans.png)
[英]Python Docstring Comments, Greater Than and Less Than Symbols Not Showing
[英]Less-than sign in python parameter docstring not showing up in PyCharm
我有一個簡單的 function 記錄如下:
def fun(x):
"""
My function
:param x: 0 <= x <= 1, blah blah
"""
pass
不幸的是,在 PyCharm 中,如果我在 function 上按 Ctrl-Q 或僅按 hover,則彈出的文檔框缺少<
符號。 相反,盒子只是說Params -- 0 = x = 1, blah blah
。 試圖逃避<
沒有幫助。 有人知道修復嗎?
編輯時:感謝@Marat,問題是 PyCharm 將 HTML 用於文檔字符串的:param
部分,但不用於文檔字符串的主體。 所以這意味着要讓所有內容正確顯示,我會做這樣的事情:
def fun(x):
"""
My function (make sure 0 <= x <= 1)
:param x: 0 <= x <= 1, blah blah
"""
pass
但是help(fun)
會顯示錯誤,但看起來這已經很好了。
它看起來像 PyCharm 中的錯誤/功能。 顯然它在文檔字符串中支持 HTML,用<
替換<
解決問題。
UPD:HTML 僅在參數/返回/數據字符串中受支持,包括 Google 樣式的定義 ( Args: ...
)。 仍然不確定它是錯誤還是功能。
聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.