파이썬에서 doxygen 구문

Question

누군가 제발 doxygen에 의해 파싱되기 위해 파이썬 코드를 올바르게 주석 처리하는 방법을 알아 내려고 도와 줄 수 있습니까?

어떻게 든 태그를 무시합니다.

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

@param name The name of the user. 

---

내가 시도 두 변종이 작동하지 않습니다 : 출력 (HTML)는 태그를 보여줍니다

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을 또한 문서화되지 않은 기능 (또는 버그)가 http://www.stack.nl/~dimitri/doxygen/docblocks.html#pythonblocks를 참조하십시오 : 당신이 느낌표 문서화 문자열 시작 경우는 문서화 문자열에서 Doxygen을 구문을 구문 분석 : 파이썬 docsting에, 당신이 필요로하는

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 

하는 것으로

\ 대신 @를 사용하여 Doxygen 명령을 시작합니다 (백 슬래시는 docstring에서 이스케이프 문자로 작동 함).

Answer 2

Doxygen을 파이썬 주석의 특수 명령을 인식 할 수 다음 댓글 양식을 사용해야합니다.

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

    def dosomething(x):   
     dosomethingelse 

는