如何使用Javadoc和Doxygen注释文件本身

Question

我在使用javadoc和doxygen来记录文件本身时遇到了问题。我可以为变量和函数生成漂亮的文档，但是对于文件本身，doxygen总是认为文件头是下一个变量或宏的文档，即使该变量或宏有自己的javadoc注释块。请看下面的示例：

/**
 * MAX9611 Sensor I2C
 *
 * @author  Saeid Yazdani
 * @date    01/07/2016
 *
 */


#ifndef MAX9611_HPP
#define MAX9611_HPP

#include "stdint.h" //for uint and stuff

/**
* max9611 RS+ ADC value is 0 to 57.3V in 12bit
* so to convert it to real voltage we need this constant 57.3/4096
* this can be used for both RS+ and OUT adc values to be converted to real V
*/
#define MAX9611_VOLT_MUL        0.0139892578125

所以，当我使用doxygen/doxywizard为这个文件生成文档时，定义的宏的文档将被该文件的标题替换。

正确的做法是什么？将文件本身记录文档（包括描述、作者、时间、版本等信息）是否被认为是一种良好的实践？如果是，如何解决我刚才描述的问题？

- Dumbo

---

你有看过\file命令吗？ - undefined

@阿尔伯特 谢谢，你是对的。也许你想把那个作为一个回答发出来吗？ - undefined

Answer 1

使用\file命令。

Doxygen手册提供了以下示例代码：

/** \file file.h
 * A brief file description.
 * A more elaborated file description.
 */
/**
 * A global integer value.
 * More details about this value.
 */
extern int globalValue;

还有一个输出链接：

- Null