在文档字符串中,如何为多个参数提供相同的描述(使用EpyText标签)?

问题描述 投票:0回答:1

对于将鼠标悬停在函数调用上显示帮助的 IDE(例如 PyCharm),而不是为多个参数创建具有相同描述的多行...有没有一种方法可以通过标记多个参数以使用相同的描述来简化?

所以代替这个(使用EpyText标签)...

def myfunc(a, b, c, d):
    """
    @param a: integer along the "a" dimension.  
    @param b: integer along the "b" dimension.  
    @param c: integer along the "c" dimension.  
    @param d: integer along the "d" dimension.
    """
    pass

...想要这样的东西(不渲染)...

def myfunc(a, b, c, d):
    """
    @param a,b,c,d: integer along the corresponding dimension.  
    """
    pass

EpyText 的替代品也可以考虑。

python pycharm docstring epytext
1个回答
0
投票

Epytext 不支持,但 NumPy 风格支持对具有相同类型和描述的参数进行分组:

def myfunc(a, b, c, d):
    """
    Parameters
    ----------
    a, b, c, d : int
        Integer along the corresponding dimension.
    """
    pass
© www.soinside.com 2019 - 2024. All rights reserved.