自动构建和发布您的文档。作为自动构建文档的一部分，注意警告，它很容易写出结构糟糕的注释。

尽可能多地使用例子。它自动将API元素链接到示例代码。

总是在类中包含描述。试着说明一个类是如何使用的，或者为什么使用它，而不仅仅是它是什么(通常只是反映了名称)。

如果您确信您的团队将遵循这样一个重量级模板，那么很好，请按照所示使用它。

否则，它看起来像JavaDoc。Doxygen的优点之一是它不需要使用如此强的标记就能很好地完成工作。你不需要使用@name，通过JAVADOC_AUTOBRIEF设置，你可以跳过@brief——只要确保注释的第一行是一个合理的简短描述。

我更喜欢描述性的名称，而不是强制的文档，并鼓励人们只在增加了重要价值时才添加注释。这样，有价值的评论就不会被所有的噪音淹没。

对于复杂的项目，有一个单独的模块管理文件可能很有用，它控制组和子组。整个层次结构可以在一个地方，然后每个文件可以简单地填充到子组中。例如:

/**
 * @defgroup example Top Level Example Group
 * @brief    The Example module.
 *
 * @{
 */

/**
 * @defgroup example_child1 First Child of Example
 * @brief    1st of 2 example children.
 */

/**
 * @defgroup example_child2 Second Child of Example
 * @brief    2nd of 2 example children.
 */

// @}

简单地在另一个组的{}中包含一个组的定义，使其成为该组的子组。然后在代码和头文件中，函数可以被标记为它们所在的任何组的一部分，这一切都可以在完成的文档中工作。它使得重构文档以匹配重构代码更加容易。

自动构建和发布您的文档。作为自动构建文档的一部分，注意警告，它很容易写出结构糟糕的注释。