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的也有未公開的特性（或錯誤）：它分析的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.stack.nl/~dimitri/doxygen/docblocks.html#pythonblocks