欢迎来到天天文库
浏览记录
ID:62033312
大小:62.00 KB
页数:6页
时间:2021-04-15
《Doxygen源代码文档自动生成器的使用笔记.doc》由会员上传分享,免费在线阅读,更多相关内容在教育资源-天天文库。
1、Doxygen源代码文档自动生成器的使用笔记在google上搜了很久的关于Doxygen使用方法的咚咚,只不过都是英文,而且都很多的规则。实际上大家只需要告诉基本的规则就可以。下面是我对Doxygen的摸索首先熟知Doxygen 产生的文件的基本结构 (以Html 和1.4.6为例 )Header(头部)MainPage FilesClasses那么我们首先建立两个类吧,以典型的 Shape和它的继承类Rectangle 为例(为了表示那些是我的解释约定~为解释符号其他的头文件和源文件的具体内容)// shape。
2、h ~在这个头文件中首先要有一些关于本文件的一些信息或者公司的copyright信息~至于你想写什么,发挥你的创意把。 /**file *<pre〉</pre> ~
</pre〉 为居中显示* <pre〉<b>CopyrightandUse</b〉</pre〉*author RichardZeng *date2006-3—23~ \author和date是 Doxygen的两个关键字author 为作者标题 \dat
3、e 为日期标题 *
zengyongjoy@gmail。com</pre〉〈b〉Allrights reserved.〈/b〉*//**classshapedefine *this isthebase classfor allShape */~ 在 Shape类定义的前面请加上解释,否则这个类就不会产生很重要的 classShape{ public:Shape(); ~Shape();virtual voidDraw(CDC*pDC);};//shape.cpp/** file*
〈b〉Richar4、d ZengShapeClassFileSource</b>CopyrightandUse〈/pre>*authorRichard Zeng *date2006—3-23*zengyongjoy@gmail.com〈/pre〉<b〉Allrightsreserved. */~上面的就不用说了吧#include"shape。h" ~解释,随便你写什么都可以的 ~这里我们可以看出在 CPP中加注释比较好 ~ 每个函数的实现都必须加上注释否则就没有这个函数拉/5、**defaultconstructor*/Shape::Shape(){ }/**destructor*/Shape::~Shape(){}/**Drawfuntion forthis shape*paramCDC* pointertoMFCCDC*/ ~\param 为Doxygen 的关键字用于定义参数~return为返回关键字void Shape::Draw(CDC* pDC) {}//Rectangle。h/**file__FILE__ *<pre>6、FileSource</b〉〈/pre>*〈pre>〈b>Copyrightand Useb>〈/pre〉*authorRichardZeng*date2006—3-23*〈pre〉zengyongjoy@gmail.com</pre>〈b>Allrightsreserved.</b〉 */ #include”shape.h"/** Rectangle class define */classRectangle:publicShape{public: Rectangle();~Rectangle();ﻩvoi7、d Draw(CDC*pDC);private:ﻩintwidth,height;};//Rectangle.cpp /** file__FILE__ *〈pre〉</pre〉 * <pre〉〈b〉CopyrightandUse</pre> *authorRichard Zeng*date2006-3-23* <pre>zengyongjoy@gmail.com〈/pre> Allrights reserved.〈/b8、>*//**defaultconstructor*/Rectangle::Rectangle(){}/**destructor*/ Rectangle::~Rectangle(){}/**Drawfunction*paramCDC*pointertoMFCCDC Class*/void Rectangle::Draw(CDC*pDC){}
4、d ZengShapeClassFileSource</b>
zengyongjoy@gmail.com〈/pre〉<b〉Allrightsreserved. */~上面的就不用说了吧#include"shape。h" ~解释,随便你写什么都可以的 ~这里我们可以看出在 CPP中加注释比较好 ~ 每个函数的实现都必须加上注释否则就没有这个函数拉/
5、**defaultconstructor*/Shape::Shape(){ }/**destructor*/Shape::~Shape(){}/**Drawfuntion forthis shape*paramCDC* pointertoMFCCDC*/ ~\param 为Doxygen 的关键字用于定义参数~return为返回关键字void Shape::Draw(CDC* pDC) {}//Rectangle。h/**file__FILE__ *<pre>
6、FileSource</b〉〈/pre>*〈pre>〈b>Copyrightand Useb>〈/pre〉*authorRichardZeng*date2006—3-23*〈pre〉zengyongjoy@gmail.com</pre>〈b>Allrightsreserved.</b〉 */ #include”shape.h"/** Rectangle class define */classRectangle:publicShape{public: Rectangle();~Rectangle();ﻩvoi
7、d Draw(CDC*pDC);private:ﻩintwidth,height;};//Rectangle.cpp /** file__FILE__ *〈pre〉</pre〉 * <pre〉〈b〉CopyrightandUse</pre> *authorRichard Zeng*date2006-3-23* <pre>zengyongjoy@gmail.com〈/pre> Allrights reserved.〈/b
8、>*//**defaultconstructor*/Rectangle::Rectangle(){}/**destructor*/ Rectangle::~Rectangle(){}/**Drawfunction*paramCDC*pointertoMFCCDC Class*/void Rectangle::Draw(CDC*pDC){}
此文档下载收益归作者所有