如何在doxygen文檔中爲圍柵代碼塊添加註釋

我在使用markdown語法的Doxygen中使用圍柵代碼塊。這可以很容易地添加一個簡單的代碼示例，這樣的：如何在doxygen文檔中爲圍柵代碼塊添加註釋

~~~~~{.cpp} 
void doSomething() 
    { 
    } 
~~~~~

當我嘗試添加註釋到使用兩個斜線圍欄代碼塊，Doxygen的似乎去掉斜線。所以，當我寫這篇文章：

~~~~~{.cpp} 
void doSomething() 
    { 
    // This function should do something 
    } 
~~~~~

我得到這樣的輸出：

void doSomething() 
    { 
This function should do something 
    }

我怎麼能告訴Doxygen的保持圍欄代碼塊中的註釋？

編輯：

完整的文件看起來像這樣（我們使用.dox標準的Doxygen擴展唯一文檔文件）：

/*! 
\page PATTERN_SAMPLE Sample 

~~~~~{.cpp} 
void doSomething() 
    { 
    // This function should do something 
    } 
~~~~~ 
*/

結果看起來是這樣的： Result

來源

2013-07-02 Patrick

你能證明上述標記是如何嵌入一個註釋塊或.MD文件？ – doxygen

我已經在問題中添加了完整的文件內容。 – Patrick

試用\ code

\code{.cpp} 
    class Cpp {}; 
    \endcode

來源

2013-07-05 07:15:07 gammay

確實有效。我知道\ code存在，但我不知道你可以在它後面添加{.cpp}。不過，{.cpp}似乎沒有什麼區別。我用一個小的for循環測試了它，它似乎只是爲「for」關鍵字着色。所有其他單詞（vector，int，push_back，main）仍然以黑色顯示。幸運的是，評論正確地與它一起工作（並且它們也被着色）。 – Patrick

我遇到同樣的問題，不需要更改代碼格式。你可以指定STRIP_CODE_COMMENTS爲NO，但是這個設置輸出源代碼和註釋。

設置STRIP_CODE_COMMENTS標籤爲YES將指示doxygen的隱藏從生成的源代碼片段任何

特殊註釋塊。正常C，C++和

Fortran註釋將始終保持可見狀態。

默認值是：YES。

STRIP_CODE_COMMENTS = NO

來源

2016-11-28 00:32:31 user2503446

如何在doxygen文檔中爲圍柵代碼塊添加註釋

回答

設置STRIP_CODE_COMMENTS標籤爲YES將指示doxygen的隱藏從生成的源代碼片段任何

特殊註釋塊。正常C，C++和

Fortran註釋將始終保持可見狀態。

默認值是：YES。

相關問題