/////////////////////////////////////////////////////////////////////////////////
/// Copyright (C), 2005-2007,
/// \file WindowsNT
/// \brief Windows Nice Try.
/// \author Bill Gates
/// \author Several species of small furry animals gathered together
/// in a cave and grooving with a pict.
/// \version 4.0
/// \date 1996-1998
/// \warning This class may explode in your face.
/// \warning If you inherit anything from this class, you're doomed.
/// \Function List:主要函数列表,每条记录应包括函数名及功能简要说明
/// 1. ...
/// \History: 修改历史记录列表,每条修改记录应包括修改日期、修改者及修改内容简述
/// <author> <time> <version > <desc>
/// Hsz 2005/4/12 1.0 build this moudle
/////////////////////////////////////////////////////////////////////////////////函数头部注释规范,列出:函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等。示例:下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内:
/////////////////////////////////////////////////////////////////////////////////
/// \fn 函数名称
/// \brief 函数功能、性能等的描述.
/// \param[in] 参数 c a char.
/// \param[out] 参数 n an int.
/// \exception 异常 std::out_of_range parameter is out of range.
/// \return 返回值 a char pointer.
/////////////////////////////////////////////////////////////////////////////////
类的头部注释规范:
/////////////////////////////////////////////////////////////////////////////////
/// \class 类名字 类所在文件 "文件路径"
/// \brief 大纲描述.
///
/// 详细描述类的功能/////////////////////////////////////////////////////////////////////////////////
类成员定义的注释规范:
成员函数
/// A function.
/// A more elaborate description of the constructor.
成员变量
///< a public variable. Details
标准类型的注释规范:
Enum
第一种方法
//////////////////////////////////////////////////
/// \enum TEnum
/// A description of the enum type.
//////////////////////////////////////////////////
enum TEnum {
Val1, /// \var Enum Val1
Val2 /// Enum Val2
};
第二种方法
enum在类内部定义
//////////////////////////////////////////////////
/// \enum An enum
/// More detailed enum description..
//////////////////////////////////////////////////
enum TEnum {
TVal1, ///< enum value TVal1.
TVal2, ///< enum value TVal2.
TVal3 ///< enum value TVal3.
}
*enumPtr, ///< enum pointer. Details.
enumVar; ///< enum variable. Details.
#define
macro宏定义//////////////////////////////////////////////////
/// \def MAX(x,y)
/// Computes the maximum of \a x and \a y.
//////////////////////////////////////////////////
typedef类型定义
//////////////////////////////////////////////////
/// \typedef std::string YString
/// typedef YString.
//////////////////////////////////////////////////
Struct结构
//////////////////////////////////////////////////
/// \struct Test struct.h "inc/ struct.h"
/// \brief This is a test struct.
/// Some details about the Test struct
///////////////////////////////////////////////////
变量定义
///////////////////////////////////////////////////
/// \var int g_nCount
/// The description of the int value.
///////////////////////////////////////////////////
您可依照此规定在你自己的程序代码中加上对应的注释。其实,无论你有没有使用Doxygen ,
都不妨按照他的格式�⒆⑹托慈耄�一方面是依照他的格式,�K不会甘于您程序的运行。
另一方面,Doxygen 所定义的都是基本程序注释应当要的东西。
如果您使用Doxygen Wizard,可直接使用上面的Run 的按�o或选项�碇谱魉得魑募�。
如果是生产HTML文件,在HTML_OUTPUT 所指定的目录中的index.html�⑹悄�说明文件的首页。
用@brief @class 代替\brief 和 \class更佳
No comments:
Post a Comment