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

Question

我在使用 javadoc 样式和 doxygen 记录文件本身时遇到问题。我可以为变量和函数生成很好的文档，但对于文件本身，doxygen 总是认为文件的 header 是紧随其后的下一个直接变量或宏的文档，即使该 var 或宏有自己的 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），定义宏的文档将被文件的 header 替换。

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

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;

和一个link to the output:

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

How to comment the file itself using Javadoc and Doxygen

documentation

javadoc

doxygen

doxywizard