Doxygen制作C和DotNet帮助文档.docVIP

简Doxygen 简介Doxygen 1 什么是Doxygen? 1 安装Doxygen 2 设定Project的doxygen组态 2 撰写正确格式的批注 5 制作说明文件 11  什么是Doxygen? Doxygen 是一个程产可将转换为说我们写程时会写对捞铁达尼号样属于针对函类别说结将批注经过处为个 纯参考手册对代码将会减少许负担过过来说对来说负担一个设计师写程时会当够在撰写批注时着过个结产这将许设计师时间Doxygen 就是这样个写批注时订规则着帮产Doxygen 的使用可分为两写Doxygen的工具来产目前Doxygen可处语 C/C++ Java IDL (Corba, Microsoft及KDE-DCOP类)?? 而可产来 HTML XML LaTeX RTF Unix Man Page 而其中还LaTeX 档后，过产PS或是PDF档在多国语Doxygen 目前可支持的约2,30种。自Doxygen 1.2.16开始(这)。所以在目前一些Open Source 的程序文件产Doxygen 算是相当语处Doxygen也算是少数在Borland C++ Builder 语还够运会本文的目的是希望在经过细阅读够给个Doxygen。至于Doxygen本身的详细参考随着Doxygen 实际Doxygen 自己的使用手册Doxygen 产他实际够产远Reference Book更复杂的 安装Doxygen Doxygen 装说简单仅绍binary档装兴从source codecompile起来请阅参考手册。请doxygen 的网站上面抓取最新版本的doxygen 回来Linux, Solaris, Mac OS X, HP-UX, 甚至是UnixWare，都有compile好的binary版本可以抓取。如果是Windows 95/98/ME/NT/2000/XP，甚至还Setup的版本可以抓取。所以安装过说简单给装录，装会问题的另外，如果您是Linux或是Windows，可以另外抓取Doxygen Wizard的程序。这个辅帮个Doxygen 的组态档过这个组态档将产来没Doxygen Wizard，还编辑将这个组态来若安装应该doxygen 这个执现统Windows 平台，则可Doxygen 这个Folder现 设Project的doxygen组态 Doxygen 产为个骤为Project 组态码Doxygen所定义Doxygen来产因此，第一步就是为Project 制作Doxygen 的组态档这个谓的组态档其实简单Key 与值的设个设定为开头为# 示该为Doxygen 会个设有两别 TAG = value [value, ...] 及 TAG += value [value, ...] 第一种形式是最常见设个TAG (个Key )为边义原则个单义内双号将义过个逗号,开来如果您要定义TAG 是属于型态会别以逗号开Doxygen 组态允许义义应说会将两个义知道这个个TAG 义来进设关于TAG 义处我们仅针对必TAG 进说请阅说由于Doxygen 的TAG 还为Doxygen 自身提供了一个选项帮Doxygen档(Doxygen 是Doxygen 预设的组态)。 doxygen Doxygen ??? 透过这个个Doxygen 档来编辑来进编辑下面将针对个TAG 进说 PROJECT_NAME Project 的名字，以一个单为个单请双号 PROJECT_VERSION Project的版本号码 OUTPUT_DIRECTORY 输径产会这个径没这个径将会径来为输径 OUTPUT_LANGUAGE 输语预设为English1.2.16 版后，您可以使用Chinese-Traditional 来输 INPUT 指定加载寻处代码档径这边个型态档径举来说a.c, b.c, c.c 三个档INPUT = a.c, b.c, c.c 的方式。若您给个录，该录档会被处 FILE_PATTERNS 如果您的INPUT Tag 中指定了目录过这个Tag来Doxygen在处时针对的档进动对录扩为.c, .cpp.h的档处设FILE_PATTERNS = *.c, *.cpp, *.h。???? RECURSIVE 这个布尔Tag，只接受YES或NO。当设定为YES时INPUT所指定目录的录会被处????????????????????????????? EXCLUDE 如果您有某几个档录，望经过Doxygen处这个Tag??? EXCLUDE_PATTERNS ?类FILE_PATTERNS的用法，只是这个TagEXCLUDE所使用。 SOURCE_BROWS