Cách chèn nhận xét nhiều dòng trong các ví dụ về mã Doxygen

Question

Tôi đang cố gắng bao gồm một ví dụ mã có chứa nhận xét nhiều dòng trong tài liệu Doxygen. Vấn đề là bộ tiền xử lý C++ diễn giải số */ khi kết thúc nhận xét Doxygen của tôi và do đó cú pháp của tệp bị hỏng.

Ví dụ:

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

Tôi đã thử các gợi ý mà làm việc cho ý kiến ​​javadoc: mã hóa các dấu gạch chéo sử dụng các thực thể HTML như thế này:

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

nhưng điều này không làm việc (tôi đoán vì Doxygen không thay thế các thực thể HTML trong các phần mã).

Vì vậy, câu hỏi đặt ra là: có thể bao gồm các nhận xét nhiều dòng trong ví dụ về mã không và làm thế nào nó có thể được thực hiện?

Answer 1

Sử dụng các kiểu nhận xét khác nhau.

Thay vì những gì bạn có, sử dụng:

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

Các /// cũng giống như /*! và đánh dấu một phần doxygen. Bộ xử lý trước sẽ coi mỗi dòng là một chú thích một dòng.