Doxygen trong cơ thể bình luận

Question

Tôi có một số mã mà tôi muốn ghi lại với ý kiến ​​trong cơ thể như vậy:

/*! \file best.cpp 
* \brief The best 
* 
* I am the best 
*/ 

/*! \fn void theBestFunction(int) 
* I'm the best blah blah blah 
*/ 
void theBestFunction(int ever) 
{ 
    doThings(); 
    /*! 
    * Does some more things 
    */ 
    doMoreThings(); 
    /*! 
    * Checks that the things it does are the best 
    */ 
    checkBest(); 
} 

Nhưng khi tôi chạy doxygen về vấn đề này có vẻ như để định dạng các khối bên trong vào các đoạn mã, như thể các lệnh @code hoặc \code đã được sử dụng (chúng không được sử dụng). Tôi muốn nhận xét trong nội dung được định dạng như văn bản thông thường.

Có ai đã từng gặp điều này trước đây không? Cảm ơn.

Answer 1

Tôi đã cố gắng khắc phục sự cố. Nó chỉ ra rằng bằng cách nào đó Doxygen đã được xử lý các khối như được thụt vào đối với nhau, và thụt đầu dòng trong Markdown (giống như trên StackOverflow) chỉ ra một khối mã (http://en.wikipedia.org/wiki/Markdown#Code) . Tôi chỉ cần tắt Markdown và sửa vấn đề.

Đối với bất kỳ ai đọc câu hỏi này trong tương lai, nếu bạn vẫn muốn hỗ trợ Markdown, hãy cẩn thận không để bắt đầu các khối bình luận trên dòng thứ 2 - bắt đầu nhận xét ngay lập tức.

Thay đổi ví dụ nhỏ của tôi như thế này:

/*! \fn void theBestFunction(int) 
* I'm the best blah blah blah 
*/ 
void theBestFunction(int ever) 
{ 
    doThings(); 
    /*! Does some more things 
    */ 
    doMoreThings(); 
    /*! Checks that the things it does are the best 
    */ 
    checkBest(); 
} 

(lưu ý sự bắt đầu của ý kiến ​​trong cơ thể ngay lập tức, như trái ngược với một dòng trống đầu tiên) giải quyết vấn đề này.