Doxygen

Doxygen is a documentation system for C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors), Fortran, VHDL, PHP, C#, and to some extent D.
Doxygen是一个为C++, C, Java, Object-C, Python, IDL(Corba和Microsoft), Fortran, VHDL, PHP, C#, D语言等设计的文档系统。

It can help you in three ways:
它可以在以下三个方面帮助你:

It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in ) from a set of documented source files. There is also support for generating output in RTF (MS-Word), PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code.
它可以生成在线文档浏览器、离线帮助。支持输出格式如RTF, PostScript, 支持超链的PDF,压缩的HTML以及Unix的man页。

You can configure doxygen to extract the code structure from undocumented source files. This is very useful to quickly find your way in large source distributions. You can also visualize the relations between the various elements by means of include dependency graphs, inheritance diagrams, and collaboration diagrams, which are all generated automatically.
在大型源码分发中它对你是非常有用的。你甚可以将不同的元素关系可视化,包括信赖图、继承关系、协作关系图等等,这些都可以自动产生。

You can even `abuse’ doxygen for creating normal documentation (as I did for this manual).
你甚至可以“滥用”它来创建常规文档(如同此文)

Doxygen is developed under Linux and Mac OS X, but is set-up to be highly portable. As a result, it runs on most other Unix flavors as well. Furthermore, executables for Windows are available.
Doxygen在Linux和MacOSX下开发,但是被设定成高可移植的。所以,它可以在其它Unix平台运行非常良好。更有,Windows下也是可用的。

来源:Doxygen

打赏

发表评论

电子邮件地址不会被公开。 必填项已用*标注