Question

我正在使用Doxygen创建一些文档，需要指出最佳实践＆＃39;用于特定环境中的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组，然后如何添加到已定义的组：

To define a group, you should put the \defgroup command in a special 
comment block. The first argument of the command is a label that should 
uniquely identify the group. The second argument is the name or title of 
the group as it should appear in the documentation. (allowing you to use 
lower-case as the initial group name)

因此，您应该使用以下内容来定义您的组：

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

并且在整个代码中，要添加一个函数等，你可以使用以下内容：

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

演示在Doxygen Code Block中使用Doxygen

2 个答案: