python中的doxygen语法

python中的doxygen语法,python,doxygen,Python,Doxygen,有人能帮我弄清楚如何正确地注释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 d

有人能帮我弄清楚如何正确地注释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


要使doxygen识别Python注释中的特殊命令,必须使用以下注释形式:

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

    def dosomething(x):         
        dosomethingelse

请参见

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文档处理中,您需要使用@而不是\来启动Doxygen命令(反斜杠在docstring中用作转义字符)。

我认为您的缩进实际上是有效的?是的。我刚刚更正了。我不允许选择工具。我得用强力剂。但我对它不是很熟悉。我读了一些关于输入过滤器的书。我使用的是doxygen版本1.7.2,这应该能够解析python???
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