Doxygen源代码文档自动生成器的使用笔记.doc

《Doxygen源代码文档自动生成器的使用笔记.doc》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、Ｄoｘyｇｅn源代码文档自动生成器的使用笔记在google上搜了很久的关于Doxｙgｅn使用方法的咚咚,只不过都是英文,而且都很多的规则。实际上大家只需要告诉基本的规则就可以。下面是我对Doxygeｎ的摸索首先熟知Dｏｘｙgen　产生的文件的基本结构　(以Htｍｌ　和1.4．6为例　)Heaｄer（头部)MaｉnPage　　FilesCｌasｓes那么我们首先建立两个类吧,以典型的　Shape和它的继承类Reｃｔaｎgle　为例（为了表示那些是我的解释约定～为解释符号其他的头文件和源文件的具体内容)//　shａpe。

2、h　～在这个头文件中首先要有一些关于本文件的一些信息或者公司的copyrｉｇｈｔ信息~至于你想写什么,发挥你的创意把。　/＊＊ｆｉle ＊<ｐｒｅ〉＜／pre＞　　　～＜／pre〉　为居中显示*　＜pｒe〉＜b>ＣopyrightanｄUｓe＜/b〉＜/pre〉＊ａuthoｒ　RiｃhaｒｄＺｅng　*datｅ２００6-3—23～　＼author和ｄate是　Ｄoｘygen的两个关键字ａutｈｏr　为作者标题　＼dａｔ

3、e　为日期标题　＊zengyongjｏy＠gｍａｉl。ｃom＜/pｒe〉〈ｂ〉Alｌrｉgｈtｓ　reｓｅrved．〈/b〉＊／/＊＊cｌassｓhapｅdefine　＊tｈis　istｈｅｂasｅ　classfor　aｌlＳｈapｅ　＊/～　在　Shape类定义的前面请加上解释,否则这个类就不会产生很重要的　ｃlaｓｓSｈape{　puｂliｃ：Ｓhape（)；　～Ｓhape（)；virtuaｌ　voidDｒaw（CDC*ｐDC);｝；//sｈape．cpｐ／＊＊　file＊

〈ｂ〉Riｃhａｒ
4、d　ZengSｈapeCｌaｓsFｉleSource<／b>CoｐｙriｇhtanｄＵsｅ〈/pｒe＞＊authorRiｃharｄ　Zeng　*date２0０６—3-23＊zengyonｇjoy＠gmaiｌ．com〈／pre〉＜b〉Allｒightsrｅsｅrved．　＊／～上面的就不用说了吧＃incluｄe"sｈape。h＂　~解释，随便你写什么都可以的　～这里我们可以看出在　ＣPP中加注释比较好　~　每个函数的实现都必须加上注释否则就没有这个函数拉/
5、*＊defauｌtconstructor＊/Shapｅ:：Shａｐe（)｛　｝/**dｅstrucｔｏr*／Shaｐｅ：：～Sｈapｅ(）{}/＊*Drawｆｕｎｔion　ｆortｈis　shape＊paramＣDC＊　pointeｒtｏMFＣCDＣ＊/　～＼parａm　为Doｘygen　的关键字用于定义参数~rｅturn为返回关键字voiｄ　Shａpｅ：：Draw（ＣDC*　pDC）　｛｝／／Rectangle。h／＊*filｅ__FILE_＿　＊<ｐｒe＞
6、FｉleSource＜/b〉〈/pre＞＊〈ｐre＞〈b>Cｏｐyrｉgｈtanｄ　UsｅAllrightsｒeservｅd．＜/ｂ〉　*／　#ｉncｌude”shaｐｅ.h＂/＊＊　Ｒectａngle　ｃlａss　ｄeｆｉne　＊/ｃlassReｃtaｎglｅ：puｂｌicShａpｅ｛ｐublic：　Rectangle（)；~Reｃｔanglｅ(）;ﻩｖoi
7、d　Ｄｒａw(ＣＤC*pDC）;ｐrｉｖate：ﻩｉnｔｗidth，height；}；/／Rectangle．cpp　/＊*　filｅ__FILE__　＊〈pｒｅ〉＜／prｅ〉　*　<ｐre〉〈b〉CｏpyｒighｔaｎdUse＜／pｒe＞　＊autｈorRｉｃharｄ　Ｚｅnｇ*daｔｅ2００6-３-２3*　<ｐｒe>ｚｅngｙongjoy＠gmail．cｏm〈/pre＞　Allrighｔs　ｒesｅｒｖed．〈／b
8、＞＊//＊＊ｄeｆaｕlｔｃoｎstructoｒ＊/Reｃtaｎglｅ：：Ｒectangｌe（）{｝／**destructor*/　Rectangle:：~Rectangle（）｛｝/＊*Drawｆunctｉon＊pａramＣDＣ*pｏintertoMFCCＤC　Claｓs＊／voｉｄ　Rectaｎgｌｅ：:Draw（CＤC＊ｐＤC）｛｝