Java有好用的JavaDoc文档生成工具,那么C++有没有呢?有,这就是大名鼎鼎的Doxygen,开源,功能强大,支持非常多的编程语言。
1992年什么命1.安装和配置
首先下载Doxygen1.5.6,然后下载graphviz‐2.18,安装。
运行Doxywizard,开始配置。
单击Wizard按钮,会弹出对话框,输入项目名,这个名字会作为文档的大标题,输入版本,也会出现在文档中,然后输入源代码的根目录,勾选”Scan recursively”,输入文档输出路径。如图1所示:
图1
单击Mode标签,不做任何改动,保持默认。
河南旅游景点大全介绍
单击Output标签,去掉”LaTex”,选择“prepare for compresd HTML(.chm)”,因为输出chm比较方便,只有一个文件就包含所有文档,不向html会有一堆的文件。如图2所示:
take的短语
图2
单击Diagrams标签,如果已经安装了GraphViz,则保持默认,如果没安装,则选择“U built‐in class diagram generator”就足够,如图3所示:
生茶熟茶的区别>办公软件学习
图3
点击OK,返回。
单击Expert按钮,会弹出一个有更多标签页的对话框,在"Project"标签页下,将OUTPUT_LANGUAGE设置为Chine,因为我需要生成中文文档,如图4所示:鱼酱的家常做法
图4
九宫格数字单击"Input"标签,将INPUT_ENCODING保持默认的utf‐8,因为我用的是Visual Studio 源代码文件的编码默认就是utf‐8。如图5所示:
如果你有洁癖,你可以耐心的将FILE_PATTERNS下的后缀一个一个删掉(用记事本打开配置文件,搜索”FILE_PATTERNS”,一下可以删除一片,免去你点鼠标点到食指抽筋之苦),只留下*.h、*.hpp、*.c、和*.cpp等,意思是只扫描C++头文件和源文件,如图6所示:
图6
下拉滚动条,会有EXCLUDE和EXCLUDE_PATTERNS表示不要进行解析的目录和文件,即工程目录下有的目录不需要进行文档化(比如测试代码),就用这两个排除掉。
单击“Source Browr”标签,勾选“SOURCE_BROUSER”,这样文档中就会附加一份源码,方便随时查阅,如图7所示:
单击"HTML"标签,勾选“HTML_DYNAMIC_SECTION”,表示要输出chm文件,同时在CHM_FILE输入文件名作为要最终生成的chm文件名,旁边的那个"File.."按钮其实没用。同时点击“HHC_LOCATION”右边的按钮找到chm编译器。如图8所示:
新闻论文
图8
单击OK返回,接下来按“”按钮保存配置文件,文件名随意,如图9所示: