c - 在 Doxygen 代码块中演示 Doxygen 的使用

Question

我正在使用 Doxygen 创建一些文档，这些文档需要指明在特定上下文中使用 Doxygen 的“最佳实践”。

我有一些文档采用以下形式:(注意，我使用的是 Doxygen 的 Markdown 扩展)

Best practices for documenting
==============================

Do it like this:

   /**
    * @defgroup my_new_group My first Doxygen Group
    * 
    * a brief desc.
    */
   ...

发生的事情是 Markdown 预处理器在 Markdown 处理器运行之前首先处理 Doxygen 命令。

是否有任何选项可以使用 Doxygen 来演示示例 Doxygen 用法？

Answer 1

不确定我是否完全理解问题。

在任何情况下，要在文档本身中包含 doxygen 命令，都需要对这些命令进行转义。

要么使用 @verbatim xxx @endverbatim 按原样输出 block ，要么使用 \@ 转义 doxygen 命令