設(shè)置為Epytext
創(chuàng)新互聯(lián)公司是一家專(zhuān)業(yè)提供廣河企業(yè)網(wǎng)站建設(shè),專(zhuān)注與成都網(wǎng)站設(shè)計(jì)、做網(wǎng)站、成都外貿(mào)網(wǎng)站建設(shè)公司、H5建站、小程序制作等業(yè)務(wù)。10年已為廣河眾多企業(yè)、政府機(jī)構(gòu)等服務(wù)。創(chuàng)新互聯(lián)專(zhuān)業(yè)的建站公司優(yōu)惠進(jìn)行中。
PyCharm 2020.3.5 (Community Edition)
def test(param1,param2,param3):
"""
:param param1:
:param param2:
:param param3:
:return:
"""
同樣的函數(shù)在pycharm2021下,每個(gè)參數(shù)都有一行type用來(lái)標(biāo)注數(shù)據(jù)類(lèi)型
PyCharm 2021.2 (Professional Edition)
def test(param1,param2,param3):
"""
:param param1:
:type param1:
:param param2:
:type param2:
:param param3:
:type param3:
:return:
:rtype:
"""
Press and go to Editor | General |Smart Keys | Python.Ctrl+Alt+S
unSelect the Insert type placeholders checkbox in the Smart Keys page of the editor settings.
編輯器 - 常規(guī) - 智能鍵 - Python,取消勾選 【在文檔注釋存根中插入類(lèi)型占位符】
官網(wǎng)提到可以把類(lèi)型和param放在同一行,原文如下:https://www.jetbrains.com/help/pycharm/using-docstrings-to-specify-types.html#param-type-specification
請(qǐng)注意,對(duì)于 reStructuredText,可以用兩種格式指定類(lèi)型:
:param param_type param_name: parameter description
(類(lèi)型描述與參數(shù)描述位于同一行)。:type param_name: param_type
(類(lèi)型說(shuō)明位于單獨(dú)的行上)
示例代碼如下,但我沒(méi)找到設(shè)置方法,我是手動(dòng)寫(xiě)的,在按下Ctrl+Q出現(xiàn)方法提示中可以看到每個(gè)參數(shù)的數(shù)據(jù)類(lèi)型
def seek( self, destination, timeout, verticalRange, callback ):
"""
調(diào)用seek函數(shù)使實(shí)體移動(dòng)到特定位置并偏航。它的運(yùn)動(dòng)速度包含在物理學(xué)的速度屬性中。它轉(zhuǎn)向目的地,并沿著直線移動(dòng),直到接近目的地,然后轉(zhuǎn)向想要的偏航。如果它被幾何體擋住了,它會(huì)一直嘗試移動(dòng),直到超時(shí)。
:param self:
:param vector4 destination:
:param int timeout:
:param int verticalRange:
:param function callback:
:return:
"""
pass
在文章中有這樣一樣方法
- Press and go to Build, Execution, Deployment | Python Debugger. In the Python Debugger page, select the Collect runtime information for code insight checkbox.Ctrl+Alt+S
構(gòu)建、執(zhí)行、部署 - Python調(diào)試器 - 勾選 【收集運(yùn)行時(shí)類(lèi)型信息以獲取代碼洞察】
我在本地這樣測(cè)試是沒(méi)有效果,可能是因?yàn)槲覀冇螒虼a在pycharm中并不能調(diào)試
我在pycharm2021下修改Docstring風(fēng)格不生效,因?yàn)榍袚Q風(fēng)格后生成的注釋都不會(huì)發(fā)生改變,比如Epytext,google。
目前還沒(méi)找到是什么原因引起的。
看了官方每一種docstrings的文檔,了解到每一種注釋風(fēng)格都是一門(mén)標(biāo)記語(yǔ)言
Legacy type syntax for docstrings | PyCharm (jetbrains.com)