doxygen是一款好用的程序员辅助工具,它可以让程序添加批添代码更加简单轻松,兼容C 、 C、Java、 Objective-C、Python等主流编程语言,小编提供的doxygen中文手册包含了基本介绍、语法技巧以及进阶技巧等内容,可以让你快速上手操作,有需要的欢迎下载。
基本介绍
Doxygen已经支持生成ANSI编码的chm目录文件(index.hhc)!Doxygen通常是用作生成英文文档的,生成中文文档需要修改输入和输出的码制,这样可以改变解析方式,生成中文文档。但是,你必须意识 到,Doxygen在从注释中抽取信息是需要做语法解析的,这些解析都是基于英文的基础,不可能在这个层面上支持中文。
Doxygen 是一个 C , C, Java, Objective-C、Python、IDL (CORBA 和 Microsoft flavors)、Fortran、VHDL、PHP、C#和D语言的文档生成器。可以运行在大多数类Unix系统,以及Mac OS X操作系统和Microsoft Windows 。 初始版本的Doxygen借鉴了一些老版本DOC 的代码;随后,Doxygen源代码由Dimitri van Heesch重写。
doxygen手册被分为三个部分,每个部分都包含若干章节。
第一部分是用户指南
1. 安装,讨论如何在你的平台中下载,编译和安装 doxygen。
2. 开始,告诉你如何快速生成第一个 doxygen 文档。
3. 代码文档化,演示代码被文档化的若干方法。
4. 列表,显示创建列表的若干方法。
5. 组合,显示如何将一些工作组合在一起。
6. 包含公式,显示如何在文档中插入公式。
7. 图形和图表,描述doxygen 生成图表和图形。
8. 预处理,解析 doxygen 如何处理宏定义。
9. 生成自动链接,显示如何在文档中放置文件,类,成员的链接。
10. 输出格式,显示如何生成doxygen 支持的多种输出格式。
11. 搜索,显示在HTML 文档中进行搜索的若干方法。
12. 自定义输出,解析如何在doxygen 中生成自定义的输出。
13. 自定义命令,显示如何在你的注释中定义和使用自定义的命令。
14. 连接到外部文档,解析如何让 doxygen 创建与外部已生成文档的链接。
15. FAQ,对频繁出现的提问给出的回答。
16. 排错,当出现问题时,它会告诉你该做些什么。
第二部分是参考指南
1. 特点,展示 doxygen 的功能概览。
2. doxygen历史,告知doxygen 在开发过程中的变化,以及它一直在进行的内容。
3. doxygen用法,告知如何使用 doxygen。
4. doxytag用法,告知如何使用 doxytag。
5. doxywizard用法,告知如何使用 doxywizard。
6. installdox用法,告知如果你使用 tag 文件,在 doxygen中如何使用生成的installdox脚本。
7. 配置,告知如何调整 doxygen,以便生成你需要的文档。
8. 特殊命令字,告知在文档中能使用的特殊命令的概览。
9. HTML命令字,告知在文档中能使用的 HTML 命令的概览。
10. XML命令字,告知在文档中能使用的 C#风格的 XML命令的概览。
第三部分为doxygen开发者提供的一些信息(略)
1. doxygen内部构造,给出 doxygen 内部结构的整体概览。
2. Perl模块的输出格式,显示如何使用 PerlMod的输出。
3. 国际化,解析如何添加新语种的输出支持。
本站所有资源均由网友贡献发布,或转载各大下载站。请自行检查软件的完整性!本网站所有资源仅供学习和参考。请勿用于商业用途,否则造成的一切后果由您自行负责!如有侵权,请联系我们删除下架。联系方式:admin@php.cn