我如何在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;
}