首页 > 代码库 > Doxygen Tool For Unity

Doxygen Tool For Unity

在之前的一系列文章中,我尝试了不同为Unity或C#生成文档

使用Doxygen生成C#帮助文档

为Unity项目生成文档(一)
为Unity项目生成文档(二)

建议的文档注释标记(C# 编程指南)

今天查阅到一个更好的方法,配合Unity使用

Doxygen Tool

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

操作步骤

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
image
3、用记事本或其它编辑器打开它,修改以下内容或使用之前介绍的方法配置Doxygen
 HAVE_DOT = YES SOURCE_BROWSER = YES DOT_PATH =“C:\Program Files (x86)\Graphviz2.38\bin” CALL_GRAPH = YES EXTRACT_PRIVATE = YES 
下面是我标注了需要修改的地方
image->image

image->image

image->image

image->image

image->image

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

image

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

image

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

imageimageimage

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

image

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

Doxygen Tool For Unity