一. 什么是Doxygen? 二. 下载地址 三. C#注释 <para> 跟在Summary之后,对方法所涉及的入口参数进行有效的解释 <returns> 对方法的返回值进行解释; <remarks> 对一些语句进行备注性描述 <see> 在生成的文档中产生一个连接到其它描述的超链接; <seealso> 与上者的区别是本标识符显示超链接在一个文档的尾部的“See Also”区域,而前者在文档之中; <value> 对一个属性进行概要性解释; <code> 如果需要置入一部分源代码段,可以使用本标识符将其标记出来 <exception> 对程序中可能抛出的异常做解释; <permission> 对方法的访问权限做一些解释: <c> 与<code>标识符基本相同,但本标识符仅用于单行代码; <example> 举例说明,通常与<code>配套使用; <paramref> 在其它地方引用一个入口参数 四. 配置 Step 2:具体配置 Wizard选项卡 Project
Mode
Output 将With search function的钩去掉
Diagrams (Use built-in class diagram generator)将使用内置的生成功能生成每个类的类图,只有一个类是不为生成的。 如果需要更加大的功能比如类继承体系图请选择第三项(Use dot tool from the GraphViz package)需要安GraphViz。
Export选项卡 Project OUTPUT_LANGUAGE选择chinese TAB_SIZE是Tab的长度
Build 默认是会生成public方法,这里也选择EXTRACT_ALL。它保证输出所有public方法及project方法,EXTRACT_STATIC是生成静态方法。
Input Input为输入目录,支持多个目录,我们可以放入项目目录和include目录,下面的Exclude是忽略目录与文件,可自行添加。
Index 选择ALPHABETICAL_INDEX,类中将有一个组合类型索引项。
生成的索引 HTML 如果你之前选择了(prepare form compressed HTML(.chm))这里抽GENERATE_HTMLHELP项会是选择状态,它下面的CHM_FILE填写你的CHM文档的名字。HHC_LOCATION则选择你的HTML Help WorkShop安装目录下的HHC程序,一般会在C:/Program Files (x86)/HTML Help Workshop/hhc.exe。选择TOC_EXPAND会生成左边的树目录。
Dot 如果你选用内置的生成功能(Use build-in class diagram generator)此时CLASS_DIAGRAMS会是选择状态,而HAV_DOT是未选择状态,如果你选择用GraphViz的dot工具生成(Use dot tool from the GraphViz package)情况则相反,请你选择上CLASS_DIAGRAMS。此时你需要设置下面的DOT_PATH为GraphViz的安装目录,否则将无法生成。 另外以下选项选择则生成对应的图,不选择则不生成。 CLASS_GRAPHS 类图 COLLABORATION_GRAPH 协作图 GROUP_GRAPHS 组图 UML_LOOK 是否UML外观 INCLUDE_GRAPH include INCLUDED BY GRAPH 被include CALL_GRAPH 调用 CALLER_GRAPH 被调用 DIRECTORY_GRAPH 目录图 GRAPHICAL_HIERARCHY 继承体系图 配置好后中进入Run选项卡单击Run Doxygen即开始生成。 生成完毕后
程序代码
|
|