Doxygen⽤户⼿册中⽂版
Main Page(糊涂熊翻译)
简介
Doxygen是⼀个⽀持C++, C, Java, Objective-C, IDL(Corba以及微软的类似东东)的⽂档系统。经过某些扩展之后还可以⽀持PHP,C#和D。
它可以从三个⽅⾯帮助你:
1. 可以从⼀套⽂档化的源代码中,⽣成⼀份可在线浏览的⽂档(HTML格式)或离线参考⼿册(LATEX格式)。还可以⽣
成RTF(MS-Word)Z, PostScript, hyperlinked PDF, compressed HTML以及Unix man pages等格式的⽂档。⽂档直接从源代码中抽取,这样很容易保持⽂档和源代码的⼀致性。
2. 可以配置doxygen来从没有⽂档化的源代码中抽取代码结构。这⼀点对于帮助你快速理清⼤型的源代码包的脉络很有帮助。你还可以通过⾃动⽣成的依赖图,继承图,协作图来将不同元素之间的关系可视化。
3. 你甚⾄可以“滥⽤”doxygen来创建普通的⽂档(本⽂档就是这样创建的)。
Doxygen是在Linux和Mac OS X上⾯开发的,但是从⼀开始就考虑了移植的⾼度⽅便性。因此,它可以在⼤多数其它的Unix类型的操作系统上运⾏得很好。甚⾄,在Windows上也可以⽤。
本⼿册分成三个部分,每⼀个部分⼜分为若⼲个章节。
第⼀部分是⼀份⽤户⼿册:
“安装”章节讨论了如何为你的平台下载,编译和安装doxygen。
“起步”章节告诉你如何快速⽣成你的第⼀份⽂档。
“源代码的⽂档化”章节演⽰了给源代码加上⽂档的各种⽅式。
“列表”章节的内容是创建列表的各种⽅式。
“合组”章节的内容是如何把相关的东东合成⼀组。
“公式的到⼊”章节的内容是如何把公式插⼊到⽂档⾥。
“图形和图表”章节描述了doxygen能够⽣成的图表和图形。
“预处理”章节解释了doxygen是如何处理宏定义的。
“链接⾃动⽣成”章节的内容是在⽂档中,怎样把链接放到⽂件,类和成员⾥⾯。
“输出格式”章节的内容是怎样⽣成doxygen⽀持的各种输出格式。
“链接到外部⽂档”章节解释了如何让doxygen创建指向外部⽂档的链接。
“常见提问”章节给出了常见提问的回答。
“故障排除”章节告诉你碰到故障该怎么办。
第⼆部分是⼀份参考⼿册:
php手册官方中文版“功能”章节是⼀个doxygen能⼲什么的概述。
“doxygen历史”章节的内容是在doxygen的开发过程中,已经做了哪些,以及还有那些事情要做。
“doxygen⽤法”章节的内容是怎样使⽤doxygen⼯具。
“doxytag ⽤法”章节的内容是怎样使⽤doxytag⼯具。
“doxywizard ⽤法”章节的内容是怎样使⽤doxywizard⼯具。
“installdox ⽤法”章节的内容是怎样使⽤再使⽤标签⽂件的情况下优doxygen⾃动⽣成的installdox脚本。“Configuration”章节的内容是如何微调doxygen,使之⽣成你所预期的⽂档。
“特殊命令”章节的内容是可以⽤在⽂档内部的特殊命令的概述。
“HTML命令”章节的内容是可以⽤在⽂档内部的HTML命令的概述。
第三部提供了⼀些开发⼈员关⼼的信息:
“doxygen的内部原理”章节是对doxygen内部结构的⼀个全局概述。
“Perl模块输出格式⽂档”章节的内容是怎样使⽤PerlMod输出。
“国际化”章节揭⽰了怎样⽀持新的输出语⾔。
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论