开启PyCharm自动函数文档注释
开启步骤:File -> Settings -> Tools -> Python Integrated Tools -> Docstrings -> Docstring format
Docstring format包括五种风格:Plain(默认)、Epytext、reStructuredText、NumPy和Google
1) Epytext效果:
def docstrings(param1, param2):
"""
Epytext风格
@param param1:
@param param2:
@return:
"""
...
2) reStructuredText效果:
def docstrings(param1, param2):
"""
reStructuredText风格
:param param1:
:param param2:
:return:
"""
...