如何在doxygen文档中为fenced代码块添加注释

Question

我使用markdown语法在Doxygen中使用受防护的代码块。这样可以轻松添加一个简单的代码示例，如下所示：

~~~~~{.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