В строке документации, как дать нескольким параметрам одно и то же описание (с использованием тегов EpyText)?
Для 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 также можно рассмотреть.
Ответы 1
Epytext этого не поддерживает, но стиль NumPy поддерживает группировку параметров одного типа и описания:
def myfunc(a, b, c, d):
"""
Parameters
----------
a, b, c, d : int
Integer along the corresponding dimension.
"""
pass
@MCornejo К сожалению, IDE должна решить, как визуализировать определенный стиль. Возможно, вы захотите открыть проблему на YouTrack (но я сомневаюсь, что она привлечет какое-либо внимание)
Это полезно. Спасибо. Это упрощает код. Однако это не упрощает отображение. При наведении курсора на имя функции всплывающая подсказка разворачивает каждый параметр на отдельную строку, и описание повторяется для каждого.