我可以避免 Pycharm Docstrings 中的变量类型字段吗?
Can I avoid variable type field in Pycharm Docstrings?
我正在使用Pycharm Docstrings reStructuredText来记录我的代码,我想知道函数文档中的变量类型是否可以自动省略,假设我有这个函数
def unsignedToSigned(inputNumber,numberType):
if(inputNumber >= 2**(numberType-1)):
signedNumber = inputNumber - 2**numberType
else:
signedNumber = inputNumber
return signedNumber
自动生成文档
def unsignedToSigned(inputNumber,numberType):
'''
:param inputNumber:
:type inputNumber:
:param numberType:
:type numberType:
:return:
:rtype:
'''
if(inputNumber >= 2**(numberType-1)):
signedNumber = inputNumber - 2**numberType
else:
signedNumber = inputNumber
return signedNumber
但是,我正在寻找类似于下面的东西
def unsignedToSigned(inputNumber,numberType):
'''
:param inputNumber:
:param numberType:
:return:
'''
if(inputNumber >= 2**(numberType-1)):
signedNumber = inputNumber - 2**numberType
else:
signedNumber = inputNumber
return signedNumber
因此,我可能会与之前的代码保持一致。这可能吗?
通过深入挖掘,感谢 this other post 我找到了解决方案,即
Settings -> Editor -> General -> Smart Keys -> Python -> Untick
Insert type placeholders in the documentation stub
干杯
我正在使用Pycharm Docstrings reStructuredText来记录我的代码,我想知道函数文档中的变量类型是否可以自动省略,假设我有这个函数
def unsignedToSigned(inputNumber,numberType):
if(inputNumber >= 2**(numberType-1)):
signedNumber = inputNumber - 2**numberType
else:
signedNumber = inputNumber
return signedNumber
自动生成文档
def unsignedToSigned(inputNumber,numberType):
'''
:param inputNumber:
:type inputNumber:
:param numberType:
:type numberType:
:return:
:rtype:
'''
if(inputNumber >= 2**(numberType-1)):
signedNumber = inputNumber - 2**numberType
else:
signedNumber = inputNumber
return signedNumber
但是,我正在寻找类似于下面的东西
def unsignedToSigned(inputNumber,numberType):
'''
:param inputNumber:
:param numberType:
:return:
'''
if(inputNumber >= 2**(numberType-1)):
signedNumber = inputNumber - 2**numberType
else:
signedNumber = inputNumber
return signedNumber
因此,我可能会与之前的代码保持一致。这可能吗?
通过深入挖掘,感谢 this other post 我找到了解决方案,即
Settings -> Editor -> General -> Smart Keys -> Python -> Untick Insert type placeholders in the documentation stub
干杯