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
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.
Có Doxygen
Ngoài ra còn có qdoc cho các dự án dựa trên C + QT. http://doc-snapshot.qt-project.org/qdoc
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.
- 1. Tài liệu giống như Javadoc cho các thư viện C/C++?
- 2. Khung tài liệu như JavaDoc cho mục tiêu C
- 3. Có một plugin giống như Javadoc cho Xcode tự động tạo mẫu tài liệu không?
- 4. Javadoc như tài liệu cho các nhận xét XML của C#
- 5. Nhập tài liệu Javadoc trên Eclipse
- 6. tạo javadoc làm tài liệu word
- 7. Tài liệu mã cho delphi tương tự như javadoc hoặc C# xml doc
- 8. Di chuyển từ Javadoc sang Tài liệu Python
- 9. Cách tạo tài liệu với NetBeans và Javadoc
- 10. tài liệu rocco phong cách cho API giống như stripe.com-?
- 11. Resteasy - tạo tài liệu REST từ Javadoc và chú thích
- 12. Visual Studio có tùy chọn tạo tài liệu html cho các nhận xét kiểu Javadoc không?
- 13. Tài liệu Hadoop cho Eclipse
- 14. Visual studio C++ trình tạo tài liệu
- 15. Netbeans C/C++ Mã JavaDoc hoàn thành
- 16. Tài nguyên tham khảo trong javadoc
- 17. Cách tốt nhất để sử dụng JavaDoc để tạo tài liệu cho Java enum là gì?
- 18. java tài liệu
- 19. Tài liệu tập tin tiêu đề C/C++
- 20. "javadoc" trong C#
- 21. Tài liệu Javadoc hiển thị tại chỗ. Có thể thấy tài liệu in đẹp trong IDE không?
- 22. XSD cho tài liệu XML được tạo cho C#?
- 23. Làm cách nào để tạo tài liệu JavaDoc cho các lớp trong tệp .jar mà tôi không có mã nguồn?
- 24. Tài liệu Api cho Rspec?
- 25. ReSharper/StyleCop giống như Visual Studio addon cho C/C++
- 26. Tài liệu cho dữ liệu?
- 27. Hosting cho javadoc?
- 28. jQuery $ (hàm() {}) và $ (tài liệu). Đã giống nhau chưa?
- 29. Thư viện giống STL tốt cho C
- 30. emacs c C++ tài liệu tham khảo
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. –