演示Block代码块中Block的用法

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原样输出块，或者使用\@转义doxygen命令

Answer 2

在Doxygen手册中，它指定了如何define组，然后如何添加到已定义的组中：

defgroup要定义一个组，您应该将\

命令放在一个特殊的注释块中。该命令的第一个参数是应唯一标识该组的标签。第二个参数是组的名称或标题，它应该出现在文档中。(允许您使用小写作为初始组名称)

因此，您应该使用类似于以下内容的方式来定义您的组：

/** Group Defines
 * @\defgroup foobar foobar
 */

在整个代码中，添加函数，等等。要做到这一点，您可以使用如下内容：

/**
 * @addtogroup foobar
 * @{
 *     (some documentation elements...)
 * @}
 */