python中的doxygen语法

Question

有人可以帮我弄清楚如何正确评论python代码以解析doxygen吗？

它以某种方式忽略了标签.输出(HTML)显示标记:

@brief Creates a new Hello object.
This Hello Object is beeing used to ...

@param name The name of the user.

---

我试过的两种变体都不起作用:

class Hello:
    """@brief short description...

    longer description
    """
    def __init__(self, name):
    """@brief Creates a new Hello object.

    This Hello Object is beeing used to ...

    @param name The name of the user.
    """
        self.name = name

---

class Hello:
    """\brief short description...

    longer description
    """
    def __init__(self, name):
    """\brief Creates a new Hello object.

    This Hello Object is beeing used to ...

    \param name The name of the user.
    """
        self.name = name

Answer 1

Doxygen还有未记录的功能(或bug):如果您使用感叹号启动docstring,它会在docstring中解析Doxygen语法:

class Hello: 
    def __init__(self, name):
    """!@brief Creates a new Hello object.

    This Hello Object is being used to...

    @param name The name of the user.
    """
    self.name = name
        dosomething(12)

    def dosomething(x):         
        dosomethingelse

请注意,在Python docsting中,您需要使用@而不是\来启动Doxygen命令(反斜杠用作docstring中的转义字符).

Answer 2

要让doxygen识别Python注释中的特殊命令,您必须使用以下注释表单:

class Hello: 
    ## \brief Short description.
    # Longer description. 
    # \param self
    # \param name
    def __init__(self, name):         
        dosomething(12)

    def dosomething(x):         
        dosomethingelse

见http://www.doxygen.nl/manual/docblocks.html#pythonblocks