AI 助理
备案控制台
开发者社区 人工智能 文章 正文

Doxygen Tool For Unity

2017-11-16 1987
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介：


文章目录[点击展开](?)[+]

  1. 一准备阶段
  2. 二Doxygen Tool
  3. 三操作步骤
    1. 配置文件修改
    2. 配置项目信息

一、准备阶段

在之前的一系列文章中，我尝试了不同方法为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/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#帮助文档


本文转自赵青青博客园博客，原文链接：http://www.cnblogs.com/zhaoqingqing/p/3955936.html，如需转载请自行联系原作者

文章标签：
C#
图形学
关键词：
doxygen unity
史迪奇abc
目录
相关文章
meteoric
|
图形学 Windows
使用Doxygen + graphviz生成Unity 3d的UGUI类图
下载软件 1） Graphviz，下载地址：http://download.csdn.net/detail/u010953266/8591169 为什么不用官网？一是下载速度慢，二是下载到本地的文件貌似是有损坏的，每次安装都报错，后来直接放弃了，从其它地方搜到的； 2）Doxygen，下载地址：https://sourceforge.
meteoric
1624 0
土木林森
|
3月前
|
图形学 C#
超实用！深度解析Unity引擎，手把手教你从零开始构建精美的2D平面冒险游戏，涵盖资源导入、角色控制与动画、碰撞检测等核心技巧，打造沉浸式游戏体验完全指南
【8月更文挑战第31天】本文是 Unity 2D 游戏开发的全面指南，手把手教你从零开始构建精美的平面冒险游戏。首先，通过 Unity Hub 创建 2D 项目并导入游戏资源。接着，编写 `PlayerController` 脚本来实现角色移动，并添加动画以增强视觉效果。最后，通过 Collider 2D 组件实现碰撞检测等游戏机制。每一步均展示 Unity 在 2D 游戏开发中的强大功能。
土木林森
183 6
土木林森
|
2月前
|
测试技术 C# 图形学
掌握Unity调试与测试的终极指南：从内置调试工具到自动化测试框架，全方位保障游戏品质不踩坑，打造流畅游戏体验的必备技能大揭秘！
【9月更文挑战第1天】在开发游戏时，Unity 引擎让创意变为现实。但软件开发中难免遇到 Bug，若不解决，将严重影响用户体验。调试与测试成为确保游戏质量的最后一道防线。本文介绍如何利用 Unity 的调试工具高效排查问题，并通过 Profiler 分析性能瓶颈。此外，Unity Test Framework 支持自动化测试，提高开发效率。结合单元测试与集成测试，确保游戏逻辑正确无误。对于在线游戏，还需进行压力测试以验证服务器稳定性。总之，调试与测试贯穿游戏开发全流程，确保最终作品既好玩又稳定。
土木林森
112 4
土木林森
|
3月前
|
图形学 缓存 算法
掌握这五大绝招，让您的Unity游戏瞬间加载完毕，从此告别漫长等待，大幅提升玩家首次体验的满意度与留存率！
【8月更文挑战第31天】游戏的加载时间是影响玩家初次体验的关键因素，特别是在移动设备上。本文介绍了几种常见的Unity游戏加载优化方法，包括资源的预加载与异步加载、使用AssetBundles管理动态资源、纹理和模型优化、合理利用缓存系统以及脚本优化。通过具体示例代码展示了如何实现异步加载场景，并提出了针对不同资源的优化策略。综合运用这些技术可以显著缩短加载时间，提升玩家满意度。
土木林森
183 5
土木林森
|
2月前
|
前端开发 图形学 开发者
【独家揭秘】那些让你的游戏瞬间鲜活起来的Unity UI动画技巧：从零开始打造动态按钮，提升玩家交互体验的绝招大公开！
【9月更文挑战第1天】在游戏开发领域，Unity 是最受欢迎的游戏引擎之一，其强大的跨平台发布能力和丰富的功能集让开发者能够迅速打造出高质量的游戏。优秀的 UI 设计对于游戏至关重要，尤其是在手游市场，出色的 UI 能给玩家留下深刻的第一印象。Unity 的 UGUI 系统提供了一整套解决方案，包括 Canvas、Image 和 Button 等组件，支持添加各种动画效果。
土木林森
141 3
土木林森
|
2月前
|
设计模式 存储 人工智能
深度解析Unity游戏开发：从零构建可扩展与可维护的游戏架构，让你的游戏项目在模块化设计、脚本对象运用及状态模式处理中焕发新生，实现高效迭代与团队协作的完美平衡之路
【9月更文挑战第1天】游戏开发中的架构设计是项目成功的关键。良好的架构能提升开发效率并确保项目的长期可维护性和可扩展性。在使用Unity引擎时，合理的架构尤为重要。本文探讨了如何在Unity中实现可扩展且易维护的游戏架构，包括模块化设计、使用脚本对象管理数据、应用设计模式（如状态模式）及采用MVC/MVVM架构模式。通过这些方法，可以显著提高开发效率和游戏质量。例如，模块化设计将游戏拆分为独立模块。
土木林森
188 3
土木林森
|
3月前
|
图形学 开发者 存储
超越基础教程：深度拆解Unity地形编辑器的每一个隐藏角落，让你的游戏世界既浩瀚无垠又细节满满——从新手到高手的全面技巧升级秘籍
【8月更文挑战第31天】Unity地形编辑器是游戏开发中的重要工具，可快速创建复杂多变的游戏环境。本文通过比较不同地形编辑技术，详细介绍如何利用其功能构建广阔且精细的游戏世界，并提供具体示例代码，展示从基础地形绘制到植被与纹理添加的全过程。通过学习这些技巧，开发者能显著提升游戏画面质量和玩家体验。
土木林森
159 3
土木林森
|
3月前
|
图形学 机器学习/深度学习 人工智能
颠覆传统游戏开发，解锁未来娱乐新纪元：深度解析如何运用Unity引擎结合机器学习技术，打造具备自我进化能力的智能游戏角色，彻底改变你的游戏体验——从基础设置到高级应用全面指南
【8月更文挑战第31天】本文探讨了如何在Unity中利用机器学习增强游戏智能。作为领先的游戏开发引擎，Unity通过ML-Agents Toolkit等工具支持AI代理的强化学习训练，使游戏角色能自主学习完成任务。文章提供了一个迷宫游戏示例及其C#脚本，展示了环境观察、动作响应及奖励机制的设计，并介绍了如何设置训练流程。此外，还提到了Unity与其他机器学习框架（如TensorFlow和PyTorch）的集成，以实现更复杂的游戏玩法。通过这些技术，游戏的智能化程度得以显著提升，为玩家带来更丰富的体验。
土木林森
64 1
土木林森
|
3月前
|
图形学 数据可视化 开发者
超实用Unity Shader Graph教程：从零开始打造令人惊叹的游戏视觉特效，让你的作品瞬间高大上，附带示例代码与详细步骤解析！
【8月更文挑战第31天】Unity Shader Graph 是 Unity 引擎中的强大工具，通过可视化编程帮助开发者轻松创建复杂且炫酷的视觉效果。本文将指导你使用 Shader Graph 实现三种效果：彩虹色渐变着色器、动态光效和水波纹效果。首先确保安装最新版 Unity 并启用 Shader Graph。创建新材质和着色器图谱后，利用节点库中的预定义节点，在编辑区连接节点定义着色器行为。
土木林森
262 0
土木林森
|
2月前
|
图形学 C++ C#
Unity插件开发全攻略：从零起步教你用C++扩展游戏功能，解锁Unity新玩法的详细步骤与实战技巧大公开
【8月更文挑战第31天】Unity 是一款功能强大的游戏开发引擎，支持多平台发布并拥有丰富的插件生态系统。本文介绍 Unity 插件开发基础，帮助读者从零开始编写自定义插件以扩展其功能。插件通常用 C++ 编写，通过 Mono C# 运行时调用，需在不同平台上编译。文中详细讲解了开发环境搭建、简单插件编写及在 Unity 中调用的方法，包括创建 C# 封装脚本和处理跨平台问题，助力开发者提升游戏开发效率。
土木林森
234 0