软件技术Doxygen:著名的源码文档生成工具

米花 发表 于:10年前 浏览量:331

Doxygen, 大名鼎鼎的文档生成工具,被很多的开源项目项目作为文档生成的工具。 

官网:Doxygen

开发语言: C++, Java, C, C#, PHP, Objective-C 2.0

参考:doxygen 源码文档管理使用指南

维护用 C/C++ 开发的遗留系统并添加新特性是一项艰难的任务。幸运的是,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是一个编写软件参考文档的工具。 该文档是直接写在代码中,因此比较容易保持更新。 Doxygen 可以交叉引用文档和代码,使文件的读者可以很容易地引用实际的代码。

简单的说,如果你准备在项目中采用Doxygen作为文档生成的工具,首先,你需 要了解,Doxygen需要什么样的代码结构才能够生产文档。 Doxygen基本上对光秃秃的代码不感兴趣,你需要在所有的类、函数、成员函数、公共变量、名字空间等代码已有表示的结构上方添加上指定格式的注 释,Doxygen才能识别出来。此外,你还可以按照指定格式的注释添加附加的信息,用以生成模块的分类,架构图之类的信息。

Doxygen通常是用作生成英文文档的,生成中文文档需要修改输入和输出的码制,这样 可以改变解析方式,生成中文文档。

本文由 米花发表。转载请注明出处:https://www.mihua.net/list/0/651.html

发表评论

您的昵称:

猜你喜欢

最近更新