Documentation 如何使用Javadoc和Doxygen注释文件本身
我在使用javadoc样式和doxygen记录文件本身时遇到问题。我可以为变量和函数生成很好的文档,但是对于文件本身,doxygen总是认为文件头是它后面的下一个立即变量或宏的文档,即使该变量或宏有自己的javadoc注释块。以下面的例子为例:Documentation 如何使用Javadoc和Doxygen注释文件本身,documentation,javadoc,doxygen,doxywizard,Documentation,Javadoc,Doxygen,Doxywizard,我在使用javadoc样式和doxygen记录文件本身时遇到问题。我可以为变量和函数生成很好的文档,但是对于文件本身,doxygen总是认为文件头是它后面的下一个立即变量或宏的文档,即使该变量或宏有自己的javadoc注释块。以下面的例子为例: /** * MAX9611 Sensor I2C * * @author Saeid Yazdani * @date 01/07/2016 * */ #ifndef MAX9611_HPP #define MAX9611_HPP
/**
* 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)时,已定义宏的文档将替换为文件头
做这种事的正确方法是什么?记录文件本身(包括描述、作者、时间、版本等信息)是否被认为是一种好做法?如果是,如何解决我刚才描述的问题?使用该命令
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;
以及:
您看过\file命令吗?@albert谢谢,您说得对。也许你想把它作为一个答案?