2009-07-17 32 views
46

Có hệ thống tạo tài liệu tương tự như Javadoc, cho C++ không? Javadoc tạo ra kết quả tốt đẹp; Nó sẽ là tuyệt vời nếu bạn có thể sử dụng một cái gì đó giống như nó trong các ngôn ngữ khác.Tài liệu giống Javadoc cho C++

Trả lời

53

Có một số công cụ mà làm việc như javadoc cho C++ Công cụ phổ biến nhất có lẽ là Doxygen. Nó có thể xử lý các nhận xét giống như JavaDoc và cũng có một số ngôn ngữ (ví dụ: C++, C, Java, Mục tiêu-C, Python, PHP, C#). Nó có hỗ trợ khá tốt cho việc tinh chỉnh kiểu dáng của đầu ra HTML bằng cách sử dụng CSS (xem users list cho các tài liệu ví dụ).

Hai vấn đề quan trọng khi lựa chọn hệ thống tài liệu là để đảm bảo rằng nó cho phép bạn

  • tài liệu các đối tượng mà bạn đang quan tâm. Bạn có muốn ghi lại hệ thống theo cấu trúc mã hoặc theo một số phân hệ mô-đun khác.
  • Lấy đầu ra được định dạng theo ý muốn. Nó là thích hợp hơn khi tài liệu phù hợp với phong cách dự án chung của bạn.

Trải nghiệm của chúng tôi với doxygen là việc thiết lập và sử dụng khá dễ dàng và kết quả đầu ra khá dễ tinh chỉnh. Thật không may, doxygen không phải là hoàn hảo, vì vậy trong một số trường hợp nó là cần thiết để làm việc xung quanh quirks hoặc lỗi nơi phân tích cú pháp doxygen phá vỡ. Hãy chắc chắn kiểm tra tất cả các tài liệu được tạo của bạn một cách cẩn thận.

+0

Liên quan đến việc phân tích cú pháp, tôi đã tìm thấy các vấn đề của tôi dường như đã được khắc phục kể từ khi chuyển sang sử dụng nhận xét XML, nhưng sau đó lại không hỗ trợ nhiều trình soạn thảo và IDE. –

20

Bạn không thể sử dụng javadoc cụ thể, nhưng có một vài công cụ mà làm những gì bạn muốn. Một trong những người có xu hướng sử dụng nhất là Doxygen. Dưới đây là một số liên kết cho Doxygen và DoC++:

Doxygen
Doc++

+0

Doxygen hoạt động tốt và được sử dụng trong một số lượng lớn các dự án. –

0

Tôi chỉ mới bắt đầu sử dụng Sphinx cho các dự án Python của mình. Trang chủ của nó nói "C/C++ cũng đã được hỗ trợ".

Nó sử dụng đánh dấu nhẹ được gọi là "reStructuredText".

Tôi vừa mới bắt đầu sử dụng nó cho các dự án Python của mình và giống như giao diện đầu ra rất nhiều.

Các vấn đề liên quan