1. Trang chủ
  2. Câu hỏi và trả lời
  3. Visual studio C++ trình tạo tài liệu

Visual studio C++ trình tạo tài liệu

2010-05-15 41 views

Trả lời

20

Bạn cũng có thể sử dụng định dạng tài liệu XML , được hỗ trợ bởi VS2010. http://msdn.microsoft.com/en-us/library/ms177226%28VS.80%29.aspx

Sau khi nhận xét mã của bạn, bạn có thể sử dụng Sandcastle để tạo tài liệu giống MSDN: http://sandcastle.codeplex.com/. (Đây là một đại diện GUI cho Sandcastle, dễ sử dụng hơn nhiều: https://github.com/EWSoftware/SHFB)

Tôi sử dụng AtomineerUtils để tạo tiêu đề XML-Tài liệu tự động. Công cụ này sẽ giúp bạn rất nhiều. Bạn có thể có phiên bản cơ sở miễn phí tại đây: http://www.atomineerutils.com/products.php

Nguồn

2010-05-15 14:48:46 Simon

+3

+1 - không chỉ sản xuất tài liệu tìm kiếm tuyệt vời, trình biên dịch sẽ chú thích đầu ra với các loại và các chú thích đó được gắn vào và tất cả các loại quà tặng khác. Nếu bạn cần phải thất bại trên một cái gì đó qua nền tảng, Doxygen có thể nhận ra định dạng này là tốt. –

+2

Tôi gặp khó khăn trong việc tìm ra điều này cho một dự án C++, tôi đã tìm thấy điều này: Cung cấp hỗ trợ cho C++ không được quản lý (http://sandcastle.codeplex.com/workitem/3855) và Mẫu bằng cách sử dụng dự án C/C++? (http://shfb.codeplex.com/discussions/217100/). Vì vậy, nó thực sự có thể sử dụng Sandcastle cho bản địa C + +? –

+0

[GhostDoc] (http://submain.com/products/ghostdoc.aspx) và [CppTripleSlash] (https://visualstudiogallery.msdn.microsoft.com/22333333-fd6f-4dcb-8223-52701eddd7ad) là các lựa chọn thay thế khác tạo tiêu đề tài liệu xml tự động – tcb

1

Một cách để tạo tài liệu là - bạn đã đoán nó - javadoc. Bạn chỉ cần nhận xét giống như cách bạn thường làm và javadoc thực hiện tốt công việc chuyển đổi chúng sang kiểu HTML/LaTeX.

Tất nhiên, đó không phải là giải pháp duy nhất. Tôi sẽ để lại chỗ cho những người khác.

Nguồn

2010-05-15 14:48:04

+1

Um .. Java và C++ là tương tự, nhưng họ không phải là tương tự. Javadoc sẽ không biết phải làm gì khi nó gặp những thứ như mẫu và như vậy trong mã nguồn. –

+0

@Billy: Mặc dù vậy, bạn có thể sử dụng bình luận kiểu Javadoc với Doxygen. –

13

Bạn có thể xem Doxygen.

Nguồn

2010-05-15 15:07:53 KTC

+0

Tôi phải nói rằng tôi không ấn tượng với Doxygen. Ngay cả bây giờ (2017) dường như không có cách nào để tạo tài liệu tham số tự động bao gồm kiểu tham số, mà bạn đã nghĩ là một yêu cầu khá cơ bản. – Neutrino

+0

Đó là dành cho C++ btw. – Neutrino

3

Bạn có thể sử dụng phần bổ trợ của mình, Atomineer Pro Documentation để nhanh chóng tạo các nhận xét tài liệu ở định dạng Tài liệu-XML, Doxygen, Qt hoặc JavaDoc. Sau đó sử dụng Sandcastle (DocXml) hoặc Doxygen (DocXml, Doxygen, Qt, Javadoc) để chuyển đổi tài liệu này thành các tệp tài liệu bên ngoài.

Tôi khuyên bạn nên sử dụng định dạng DocXml vì tất cả các công cụ trên đều hoạt động với nó, và Visual Studio nhận ra nó (cú pháp tô màu và tạo tài liệu vào cơ sở dữ liệu intellisense để nó xuất hiện trong trợ giúp công cụ như bạn gõ tên lớp/phương thức vào mã của bạn).

Nguồn

2010-05-15 16:01:33

0

Nếu bạn đang sử dụng Visual Studio 2015 thì có một trình tạo Doxygen được viết cho tiện ích mở rộng trình khám phá macro sử dụng JavaScript cho ngôn ngữ macro của nó.

dự án là trên github đây: https://github.com/cppocl/visual_studio_macros

Nguồn

2016-11-02 07:35:49 Curg

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

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