在文档中引用另一个参数的Python方法是什么?我应该这样做吗?
例如─
def _private_func(param1):
"""
description of the function
:param1: here I want to refer the documentation of 'param1' in the main function/
"""
def main_function(param1):
"""
description of the function
:param1: a long explanation about param1
"""
我使用的是pycharm,所以如果有一种方法可以将引用与pycharm集成在一起,那就太棒了。
1条答案
按热度按时间3htmauhk1#
在文档字符串中,你只需要复制并粘贴两个文档中的描述,可能会提到它引用了main()函数中的同一个参数。