如何在 Doxygen 的示例中保留评论答案

【问题标题】：How do I preserve a comment in an example in Doxygen如何在 Doxygen 的示例中保留评论
【发布时间】：2015-08-20 22:30:09
【问题描述】：

我有一个简单的方法，我想在我的 doxygen 主页中用作示例：

\code

    void showNum(int numToDisplay){

        // This is just a method to display a value.
        std::cout<<"Displaying Number "<<numToDisplay<<std::endl;
    }

\endcode

生成文档时，主页将正确显示代码示例，但注释将一直到主页的左边缘。我使用什么字符来强制评论保持其理由和显示？

提前感谢您的帮助。

【问题讨论】：

标签： c++ doxygen

【解决方案1】：

如果没有更多信息，将很难诊断此问题，但需要检查几件事：

确保您的代码前有一个空行。
确保有四个空格缩进
确保评论前的空白不是制表符

听起来好像您的代码没有被解释为代码块（由于上面列出的原因之一）。如果您可以发布至少部分包含代码块的文件，它可能有助于解决这个问题。

这是一个小例子，似乎可以满足您的要求：

/**
 * @file tmp.cpp
 */

/** Brief description
 *
 * Long description of what the function does ...
 *
 * \code{.cpp}
 *
 *     void showNum(int numToDisplay){
 *
 *         // This is just a method to display a value.
 *         std::cout<<"Displaying Number "<<numToDisplay<<std::endl;
 *     }
 *
 * \endcode
 *
 */
void showNum(int numToDisplay) {
   std::cout << "Displaying Number " << numToDisplay << std::endl;
}

【讨论】：

只需将 {.cpp} 放入我的代码标签即可解决问题。谁会想到？谢谢。