Vinova tuyển lập trình viên Mobile & Web ở Hà Nội, lương $300-1000

Article: Doxygen - Công cụ tạo document hiệu quả 2046

documentation, doxygen
phananhvu.myopenid.com 125
Updated 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:

  1. It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in $\mbox{\LaTeX}$) 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.
  2. 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.
  3. 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.

 

Comments

phananhvu.myopenid.com 125
over 3 years ago

Kỉ niệm bài viết thứ 100 bằng một công cụ rất hữu hiệu :D

otaku-2r.myopenid.com 2
over 3 years ago

Cái tool này dùng browse code Linux kernel tuyệt vời... Hồi trước tớ để máy tính hơn 1 ngày để index toàn bộ mã nguồn nhân Linux 2.6.x. Thành quả thì khỏi nói mỗi tội dung lượng thì hết hồn.

phananhvu.myopenid.com 125
over 3 years ago

Đúng rồi. Ngày xưa anh em mình tạo doxycument cho cái của nợ ffmpeg chả mất cả buổi còn gì :D Nếu dùng chức năng generate graph thì sẽ rất lâu.

Doxycument của Linux kernel nặng bao nhiêu hả anh Hải :D

otaku-2r.myopenid.com 2
over 3 years ago

3~4G gì đó không nhớ con số chính xác, đại thể là có chọn mấy thứ linh tinh như tree, graph, search v..v... cho đẹp mắt. Index load tree ì ạch vì có quá nhiều subroutine và struct.

phananhvu.myopenid.com 125
over 3 years ago

ọe,

3 ~ 4GB gì đó á.

ợ ợ

You must login to be able to comment

Uploaded files

No file uploaded yet

You must login to be able to upload

Nhà tài trợ:

Mọi người đều tự do viết bài, sửa bài của người khác, và bình luận ở trang web này. Bạn muốn chủ động tạo bài mới để chia sẻ kinh nghiệm với mọi người? Xin click link ở dưới.

Create new content