一、准备阶段

在之前的一系列文章中,我尝试了不同方法为Unity的C#生成脚本手册(帮助文档)
  1. 使用Doxygen生成C#帮助文档
  2. 为Unity项目生成文档(一)为Unity项目生成文档(二)
  3. 建议的文档注释标记(C# 编程指南)
今天查阅到一个更好的方法,可以直接在Unity中使用

二、Doxygen Tool

Doxygen Tool For Unity_C#

官方网站:http://www.jacobpennock.com/Blog/?p=629

Unity论坛:http://forum.unity3d.com/threads/free-plugin-for-automatic-documentation-of-your-project-through-doxygen.128355/

Doxygen Tool For Unity_软件_02

三、操作步骤

1、下载好doxygen tool的 unity package

地址: https://www.assetstore.unity3d.com/en/#!/content/13962 或 http://jacobpennock.com/unityplugins/DoxygenForUnity.zip

2、把Asset Package导入Unity后,找到此配置文件BaseDoxyfile.txt

Doxygen Tool For Unity_软件_03

配置文件修改

3、用记事本或其它编辑器打开它,修改以下内容或使用之前介绍的方法配置Doxygen

 HAVE_DOT = YES
 SOURCE_BROWSER = YES
 DOT_PATH =“C:\Program Files (x86)\Graphviz2.38\bin”
 CALL_GRAPH = YES
 EXTRACT_PRIVATE = YES 

下面是我标注了需要修改的地方

->

Doxygen Tool For Unity_软件_04->Doxygen Tool For Unity_软件_05

Doxygen Tool For Unity_unity_06->Doxygen Tool For Unity_C#_07

Doxygen Tool For Unity_unity_08->Doxygen Tool For Unity_C#_09

Doxygen Tool For Unity_unity_10->Doxygen Tool For Unity_软件_11

4、回到Unity,点击 Window/Documentation with Doxygen

Doxygen Tool For Unity_软件_12

5、会弹出一个Documentation的窗口,红色信息提示你需要配置doxygen

Doxygen Tool For Unity_C#_13

配置项目信息

6、根据自己的项目情况,配置信息;配置完成后,切换到Generate Document选项卡,点击Run Doxygen

Doxygen Tool For Unity_unity_14Doxygen Tool For Unity_软件_15Doxygen Tool For Unity_软件_16

7、弹出Doxygen的窗口,切换到Run选项卡,运行Doxygen生成文档

Doxygen Tool For Unity_C#_17

如果有不明白的同学,请查看我写的关于Doxygen使用的文章:使用Doxygen生成C#帮助文档