Doxygen 코드 예제에 여러 줄 주석을 삽입하는 방법

Question

Doxygen 설명서에 여러 줄 주석이 포함 된 코드 예제를 포함하려고합니다. 문제는 C++ 전처리 기가 내 Doxygen 주석의 끝으로 */을 해석하므로 파일 구문이 잘못되었습니다. 이 같은 HTML 엔티티를 사용하여 슬래시를 인코딩 : : 이미의 JavaDoc 주석 작동 제안 시도

/*! \brief My Doxygen comment. 
* 
* \code 
* myFunction() /* Some multi-line comment */ 
* \endcode 
*/ 

: 예를 들어

* \code 
* myFunction() /* Some multi-line comment */ 
* \endcode 

을하지만이 작동하지 않습니다 (나는 생각한다 Doxygen은 코드 섹션에서 HTML 엔티티를 대체하지 않기 때문에).

그래서 질문은 : 코드 예제에 여러 줄 주석을 포함 할 수 있으며 어떻게 수행 할 수 있습니까?

Answer 1

다른 의견 스타일을 사용하십시오. 대신 당신이 무엇을

, 사용 :

/// \brief My Doxygen comment. 
/// 
/// \code 
/// myFunction() /* Some multi-line comment */ 
/// \endcode 
/// 

///는 /*!과 동일하고, doxygen이 부분을 표시합니다. 전 처리기는 각 행을 단일 행 주석으로 처리합니다.