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 时，它似乎将内部 block 格式化为代码片段，就好像 @code 或 \code使用了命令(但没有使用)。我希望体内评论的格式与普通文本一样。

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

Answer 1

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

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

将我的最小示例更改为:

/*! \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();
}

(注意立即开始的正文评论，而不是首先是空白行)解决了这个问题。