documentation - 如何在 doxygen 文档中向受保护的代码块添加注释

Question

我在 Doxygen 中使用 markdown 语法使用围栏代码块。这样可以很容易地添加一个简单的代码示例，如下所示：

~~~~~{.cpp}
void doSomething()
   {
   }
~~~~~

当我尝试使用两个正斜杠将注释添加到受保护的代码块中时，Doxygen 似乎删除了斜杠。所以当我写这个时：

~~~~~{.cpp}
void doSomething()
   {
   // This function should do something
   }
~~~~~

我得到这个输出：

void doSomething()
   {
This function should do something
   }

我如何告诉 Doxygen 将注释保留在受保护的代码块中？

编辑：

完整的文件如下所示（我们使用 .dox 的标准 Doxygen 扩展名作为纯文档文件）：

/*!
\page PATTERN_SAMPLE Sample

~~~~~{.cpp}
void doSomething()
   {
   // This function should do something
   }
~~~~~
*/

结果如下所示：

Answer 1

尝试使用 \code

  \code{.cpp}
  class Cpp {};
  \endcode

Answer 2

我遇到了同样的问题。无需更改代码格式。您可以指定STRIP_CODE_COMMENTS为NO：此设置输出带有注释的源代码。

# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
# special comment blocks from generated source code fragments. Normal, C++ and
# Fortran comments will always remain visible.
# The default value is: YES.

STRIP_CODE_COMMENTS    = NO