Article:
Doxygen - Công cụ tạo document hiệu quả
2046
phananhvu.myopenid.com 125Updated over 3 years ago |
Nghe nói đa số developer thích coding hơn cả đi chơi với bạn gái và ghét viết document hơn cả việc bạn gái đi chơi với developer khác.
Thật may, đã có doxygen cứu nguy: Vâng, anh developer thì chỉ việc develope. Còn việc tạo document thì anh để em doxygen làm cho.
Với những ai đã biết đến Javadoc thì Doxygen thực sự đáng là đàn anh!!!
Giới thiệu
Hiện tại doxygen có thể tạo document cho các project viết bằng C++, C, Java, Objective-C, Python, IDL, Fortran, VHDL, PHP, C#, D.
Doxygen 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.
- 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.
Xem:
Kinh nghiệm
Doxygen thực sự hữu ích khi cần nghiên cứu các project opensource. Chức năng nổi bật nhất của doxygen là tạo ra đồ thị quan hệ class vô cùng trực quan, giúp việc nắm bắt cấu trúc của các project phức tạp trở nên đơn giản hơn rất nhiều.
documentation, doxygen
125
)
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. 
over 3 years ago
over 3 years ago
over 3 years ago
over 3 years ago
over 3 years ago