c++ - Doxygen 体内评论

Question

我有一些代码要记录在正文中，如下所示：

/*! \file best.cpp
 *  \brief The best
 *
 *  I am the best
 */

/*! \fn void theBestFunction(int)
 * I'm the best blah blah blah
 */
void theBestFunction(int ever)
{
    doThings();
    /*!
     * Does some more things
     */
    doMoreThings();
    /*!
     * Checks that the things it does are the best
     */
    checkBest();
}

但是当我运行它时doxygen，它似乎将内部块格式化为代码片段，就好像使用了@codeor\code命令（它们不是）。我希望正文评论的格式与普通文本一样。

有没有人遇到过这个？谢谢。

Answer 1

我设法解决了这个问题。事实证明，Doxygen 以某种方式将这些块处理为相对于彼此缩进，并且 Markdown 中的缩进（很像 StackOverflow 上的缩进）表示代码块（http://en.wikipedia.org/wiki/Markdown#Code） . 我只是关闭了 Markdown 并解决了这个问题。

对于将来阅读此问题的任何人，如果您仍然需要 Markdown 支持，请注意不要在第 2 行开始评论块——立即开始评论。

将我的最小示例更改为：

/*! \fn void theBestFunction(int)
 * I'm the best blah blah blah
 */
void theBestFunction(int ever)
{
    doThings();
    /*! Does some more things
     */
    doMoreThings();
    /*! Checks that the things it does are the best
     */
    checkBest();
}

（请立即注意正文内注释的开头，而不是先空行）解决了这个问题。