Группы членов Doxygen и подсказки типа с помощью doxypypy в коде Python - PullRequest
Новая
       71

Группы членов Doxygen и подсказки типа с помощью doxypypy в коде Python

0 голосов
/ 31 мая 2019

Я использую doxygen в сочетании с doxypypy для документирования исходного кода Python. 

class Test:
    """
    This is a test class.

    The thest class only serves the purpose of a MWE.

    Attributes:
        memberA (int): This is member A.
        memberB (int): This is member B.
        memberC (int): This is member C. A and B never invite C to their party.
    """

    def __init__(self):
        self.memberA = []
        self.memberB = []
        self.memberC = []

Теперь я хочу сгруппировать членов A и B в группу участников (с использованием @{, @} и т. Д.), Но несколько попыток реализовать это в строке документации были тщетными. , Каков правильный синтаксис достижения этого? (Я вообще новичок в Python, я со стороны C ++ ... Я использую стиль комментирования Google)

РЕДАКТИРОВАТЬ: Кроме того, мне не удалось выяснить, какие форматы я могу использовать сейчас. Я знаю, что могу использовать специальные команды doxygen, но умеет ли doxypypy читать, например, Google Style Doc?

EDIT2: я также обнаружил, что doxygen / doxypypy игнорирует подсказки типа ... кто-нибудь знает, как их включить?

...