Doxygen Tool For Unity

本文为作者原创,转载请注明出处:https://www.cnblogs.com/zhaoqingqing/p/3955936.html



一、准备阶段#

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

二、Doxygen Tool#

image

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

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

image

三、操作步骤#

1、下载好doxygen tool的 unity package

地址: https://www.assetstore.unity3d.com/en/#!/content/13962http://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#帮助文档

作者:赵青青   一名在【网易游戏】做游戏开发的程序员,擅长Unity3D,游戏开发,.NET等领域。
本文版权归作者和博客园共有,欢迎转载,转载之后请务必在文章明显位置标出原文链接和作者,谢谢。
如果本文对您有帮助,请点击【推荐】您的赞赏将鼓励我继续创作!想跟我一起进步么?那就【关注】我吧。
posted @   赵青青  阅读(1717)  评论(0编辑  收藏  举报
编辑推荐:
· .NET Core 托管堆内存泄露/CPU异常的常见思路
· PostgreSQL 和 SQL Server 在统计信息维护中的关键差异
· C++代码改造为UTF-8编码问题的总结
· DeepSeek 解答了困扰我五年的技术问题
· 为什么说在企业级应用开发中,后端往往是效率杀手?
阅读排行:
· 10亿数据,如何做迁移?
· 推荐几款开源且免费的 .NET MAUI 组件库
· 清华大学推出第四讲使用 DeepSeek + DeepResearch 让科研像聊天一样简单!
· 易语言 —— 开山篇
· Trae初体验
历史上的今天:
2013-09-04 Unity 碰撞器
CONTENTS
点击右上角即可分享
微信分享提示