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

【问题标题】：How to add comments to fenced code block within doxygen documentation如何在 doxygen 文档中向受保护的代码块添加注释
【发布时间】：2013-07-02 13:24:19
【问题描述】：

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

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

当我尝试使用两个正斜杠将 cmets 添加到围栏代码块中时，Doxygen 似乎删除了斜杠。所以当我写这个时：

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

我得到这个输出：

void doSomething()
   {
This function should do something
   }

我如何告诉 Doxygen 将 cmets 保留在围栏代码块中？

编辑：

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

/*!
\page PATTERN_SAMPLE Sample

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

结果如下所示：

【问题讨论】：

您能说明上述标记是如何嵌入到注释块或 .md 文件中的吗？
我已经在问题中添加了完整的文件内容。

标签： documentation doxygen

【解决方案1】：

用\code试试

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

【讨论】：

确实有效。我知道 \code 存在，但我不知道您可以在其后添加 {.cpp}。但是，{.cpp} 似乎没有什么不同。我用一个小的for循环对其进行了测试，它似乎只为“for”关键字着色。所有其他单词（vector、int、push_back、main）仍以黑色显示。幸运的是，cmets 可以正常使用它（并且它们也是彩色的）。

【解决方案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

【讨论】：