如何在Doxygen的示例中保留注释

Question

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

\code

    void showNum(int numToDisplay){

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

\endcode

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

提前感谢您的帮助。

Answer 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;
}