Doxygen Tool For Unity

简介:



一、准备阶段

在之前的一系列文章中,我尝试了不同方法为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

  

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

->

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,如需转载请自行联系原作者

相关文章
|
7月前
|
图形学
|
API Python
Anaconda+VSCode+QT Designer配置PyQt5环境
本文使用Anaconda+VSCode配置PyQt5环境,在开始之前新建Anaconda的虚拟环境,如果不需要虚拟环境可以直接使用默认的Base环境。另外针对ui文件转py文件报错ImportError: DLL load failed: 找不到指定的模块给出了解决办法
|
iOS开发
Xcode设置编译链接-framework CoreFoundation
Xcode设置编译链接-framework CoreFoundation
68 0
Xcode设置编译链接-framework CoreFoundation
|
开发工具
AndroidStudio插件开发(进阶篇之Editor)
AndroidStudio插件开发(进阶篇之Editor)
AndroidStudio插件开发(进阶篇之Editor)
|
监控 Java 区块链
ABAP Development Tool 代码模板和其他一些实用技巧汇总
ABAP Development Tool 代码模板和其他一些实用技巧汇总
281 0
ABAP Development Tool 代码模板和其他一些实用技巧汇总
|
前端开发 Java
ABAP Development Tools的语法高亮实现原理
ABAP Development Tools的语法高亮实现原理
134 0
|
异构计算
好工具推荐系列:OpenGL Extensions Viewer
好工具推荐系列:OpenGL Extensions Viewer
177 0
|
Java uml
mac上为sublime text安装plantuml插件的正确姿势
mac上为sublime text安装plantuml插件的正确姿势
180 0
|
人工智能 测试技术 程序员
书籍:Pro Python 3 3rd -2019: Features and Tools for Professional Development .pdf
简介 优化您的编程技巧和方法,以成为更高效和创造性的Python程序员。本书探讨了概念和功能,这些概念和功能不仅可以改进您的代码,还可以通过Python理念的见解和细节来理解Python社区。 Pro Python 3,第三版为您提供编写干净,创新代码的工具。

热门文章

最新文章