1，生成CHM：
2，生成RTF:
一，注释风格
1， 类注释：写在类名的上一行。
/**
* 类的介绍
*@author 作者
*@date 时间
*@note 注释
*/
Public class MyClass{};
2, 成员注释：写在注释的上一行
/** 成员变量描述 */
int m_Var;
3, 函数：写在函数的上一行
/**
* 函数功能描述
* @param p1 输入参数p1描述
* @param p2 输入参数p2描述
* @return 输出参数（返回值）描述
*/
int testMe(int a,const char *s);
附加可选常用参数：
类：
* @brief 类的简介，生成word文档时在目录附带
* @version 1.1 --版本号
函数：
* @note 注意，调用此方法时要XXX --备注
* @exception IOException 抛出IO异常 --异常
* @see 参考IDAO接口的XX --参考
实例：
#pragma once
/**
* 此类是一个动物抽象类， 所有动物都继承此类。
*@author 袁 *@date 2013-2-20 14:25:17
*@note 测试注释，可以不写这个参数。
*/
class Animal
{
/**动物的年龄*/
public:int age;
/**动物的ID*/
int id;
/**
* 根据ID得到动物的年龄
* @param aid 动物的ID
* @return 返回动物的年龄
*/
public: int getAge(int aid){
if(aid==id){
return age;}
else{
return -1;
}
}
public:
Animal(void);
~Animal(void);
};
生成word文档：
类索引
类列表
这里列出了所有类、结构、联合以及接口定义等，并附带简要说明:
Animal .................................................................................................................................................... pagenum
类说明
Animal类 参考
#include <Animal.h>
Public 成员函数
l int getAge (int aid)
Public 属性
l int age
l int id
详细描述
此类是一个动物抽象类， 所有动物都继承此类。
作者:
袁
日期:
2013-2-20 14:25:17
注解:
测试注释，可以不写这个参数。
在文件 Animal.h 第 8 行定义.
成员函数说明
int Animal::getAge (int aid)[inline]
根据ID得到动物的年龄
参数:
|
aid |
动物的ID |
返回:
返回动物的年龄
在文件 Animal.h 第 19 行定义.
类成员变量说明
int Animal::age
动物的年龄
在文件 Animal.h 第 11 行定义.
int Animal::id
动物的ID
在文件 Animal.h 第 13 行定义.
该类的文档由以下文件生成:
l E:/C/myPro01/myPro01/Animal.h
l E:/C/myPro01/myPro01/Animal.cpp