Doxygen là công cụ chuẩn để tạo tài liệu từ mã nguồn C++ có chú thích, cũng hỗ trợ C, C#, Java, Python, Fortran, VHDL, Tcl...
Cài đặt Doxygen
Sử dụng lệnh sau:
$ sudo apt-get install doxygen
Quá trình cài đặt sẽ tải và cài đặt các gói phụ thuộc: libclang, libllvm, libobjc, graphviz...
Kiểm tra cài đặt
$ doxygen --help
Hiển thị phiên bản và các tùy chọn sử dụng.
Tạo file cấu hình
$ doxygen -g sample_text.conf
Tạo file cấu hình mẫu sample_text.conf chứa các thiết lập dự án.
Tạo tài liệu
$ doxygen sample_text.conf
Doxygen sẽ quét mã nguồn, phân tích, và tạo tài liệu HTML/LaTeX/RTF trong thư mục html/.
Xem tài liệu HTML
$ cd html $ google-chrome index.html
Sau bài viết này, bạn sẽ hiểu cách cài đặt và sử dụng Doxygen trên Ubuntu. Các bài tiếp theo sẽ chia sẻ thêm mẹo Linux.