Doxygen içinde vücut yorumlar

Question

ben şöyle gövde içi yorumlarla belgelemek isteyen bazı kodlar vardır:

/*! \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(); 
} 

Ama bu konuda doxygen çalıştırdığınızda o kod parçalara iç bloklar biçimlendirmek gibi görünüyor, @code veya \code komutları kullanılıyordu (bunlar değil). Vücut içi yorumların normal metin gibi biçimlendirilmesini isterim.

Daha önce bununla karşılaştı mı? Teşekkürler.

Answer 1

Sorunu gidermeyi başardım. Bir şekilde, Doxygen'in bu blokları birbirine göre girintili olarak işlediğini ve Markdown'daki (StackOverflow'ta olduğu gibi) bir kod bloğunu (http://en.wikipedia.org/wiki/Markdown#Code) gösterdiği anlaşılıyor. . Sadece Markdown'u kapattım ve sorunu çözdüm.

Gelecekte bu soruyu okuyan herkes için, hala Markdown desteğini istiyorsanız, 2. satırdaki yorum bloklarını başlatmamaya dikkat edin - yorumları hemen başlatın.

bu benim az örneği değiştirme:

/*! \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(); 
} 

(ilk boş satıra aksine, derhal vücut yorumların başlangıç ​​unutmayın) sorunu çözer.