Nhân sư có phù hợp với tài liệu C++ không?

Tôi muốn thử các trình tạo tài liệu cho một dự án mới trong C++. Tôi nghĩ rằng các lựa chọn của tôi là Doxygen hoặc Sphinx. Vì tôi có các dự án trong Python mà tôi muốn sử dụng Sphinx, tôi tự hỏi liệu Sphinx có phải là lựa chọn đúng cho C++ hay không. Trang web Sphinx nói rằng C++ được hỗ trợ, nhưng tôi không thể tìm thấy tài liệu để bắt đầu với tài liệu C++.Nhân sư có phù hợp với tài liệu C++ không?

Một câu hỏi tương tự đã được discussed on Stackoverflow và câu trả lời chính kết luận:

chưa hoàn toàn có thể sử dụng,
nhưng tiếp tục theo dõi

Kể từ khi các cuộc thảo luận là cũng hơn một năm cũ , Tôi tự hỏi liệu kết luận này vẫn còn hợp lệ. Tôi có nên chọn Doxygen trên Sphinx cho tài liệu C++ của mình không?

Nguồn

2012-10-17 clstaudt

Tôi không biết về Sphinx, nhưng tôi nghĩ Doxygen thực sự là một công cụ tuyệt vời! Bạn đã tìm thấy vấn đề gì về Doxygen? – lucasg

@georgesl Vấn đề duy nhất tôi có với Doxygen hiện tại là tôi sẽ sử dụng Sphinx cho các dự án Python của tôi và muốn tránh sử dụng hai hệ thống tài liệu khác nhau. Nó có thể mất thời gian để bắt đầu với mỗi cái, và làm quen với cú pháp. – clstaudt

Trên thanh bên tay phải trên trang web của họ, có một liên kết đến một nhóm Google và một xử lý trò chuyện FreeNode. Bạn đã thử những? Tôi không nhất thiết phải nói câu hỏi này không thuộc về đây, chỉ là tôi nghĩ rằng bạn sẽ có nhiều khả năng để có được một phản ứng thông báo ở đó. –

Nhân sư không thể trích xuất tài liệu từ nguồn C++ một mình. Tuy nhiên, có phần mở rộng, đáng chú ý nhất là Breathe, sử dụng Doxygen để trích xuất tài liệu từ C++. Tôi đã không kiểm tra bất kỳ trong số này.

Nguồn

2012-10-18 12:05:35 lunaryorn

Có vẻ như tôi vẫn cần sử dụng cú pháp Doxygen kỳ lạ nếu tôi sử dụng Hít thở. : - / –

Đối với C++ Doxygen rất tốt; Hỗ trợ Sphinx của C++ được thực hiện thông qua Doxygen (sử dụng Breathe).

Bạn chỉ muốn có một công cụ cho hai ngôn ngữ, để cải thiện khả năng bảo trì. Doxygen can generate a documentation from Python code, vì vậy tôi khuyên bạn nên sử dụng Doxygen cho cả hai nguồn, nếu có thể. Here is a tutorial for Doxygen and Python.

Nguồn

2012-10-17 14:27:18 Synxis

+18

Tôi có nhiều năm lập trình Python chưa bao giờ thấy bất kỳ dự án Python nào sử dụng Doxygen. Nó hoàn toàn là một công cụ không chuẩn trong cộng đồng Python, và nó không giống như bạn sẽ tìm thấy nhiều trợ giúp nếu bạn từng gặp vấn đề. – lunaryorn

Đối số của bạn là 'Doxygen là xấu cho Python vì không ai sử dụng nó'? Xin lỗi, nhưng điều này không đúng. Ví dụ: xem http://code.foosel.org/doxypy, http://www.stack.nl/~dimitri/doxygen/docblocks.html#pythonblocks, http://engtech.wordpress.com/2007/03/20/automatic_documentation_python_doxygen/(vì vậy có những người interessted trong Doxygen với Python). – Synxis

Một số kết quả của Google không thực sự đánh bại tuyên bố của tôi rằng đó là một công cụ không chuẩn trong cộng đồng. Sử dụng rộng rãi Doxygen trong các dự án quan trọng sẽ, nhưng không có. Không có dự án Python đáng kể nào đang sử dụng Doxygen cho tài liệu, hoặc đã làm như vậy trong quá khứ. Heck, thậm chí không Zope không ... – lunaryorn

Nhân sư có phù hợp với tài liệu C++ không?

Trả lời

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