如何在 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

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

确保代码前有一个空行。
确保你有四个 spaces 缩进
确保评论前面的白色 space 不是制表符

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

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

/**
 * @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;
}

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

How do I preserve a comment in an example in Doxygen

c++

doxygen