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?

Question

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? Nếu vậy, bước nào là cần thiết để thực hiện điều này?

Trong BlueJ, có tùy chọn dịch nhận xét kiểu Javadoc thành tệp html.

Giống như hình ảnh dưới đây cho thấy cho Java sử dụng BlueJ Tôi muốn làm điều tương tự với Visual Studio: http://www.time-tripper.com/uipatterns/Patterns/Titled_Sections/javadoc.gif http://www.time-tripper.com/uipatterns/Patterns/Titled_Sections/javadoc.gif

Answer 1

Bạn có thực sự có nghĩa javadoc, trong Java? Nếu vậy, tôi không tin như vậy - chỉ cần sử dụng javadoc chính nó. Visual Studio không thực sự hỗ trợ Java.

Nếu bạn có nghĩa là ý kiến ​​tài liệu C# XML, thì bạn có thể thay đổi thuộc tính dự án để xây dựng tệp XML và sau đó sử dụng NDoc (ngừng) hoặc Sandcastle để xây dựng HTML (hoặc chm, v.v). Nó không phải là dễ dàng như nó có thể được, thừa nhận.

CHỈNH SỬA: Nếu bạn đang sử dụng C++, có thể bạn nên xem Doxygen. Có thể có các plugin Visual Studio, nhưng bạn có thể tốt nhất chỉ cần chạy Doxygen như là một phần của quá trình xây dựng của bạn. Nếu bạn đang sử dụng C++/CLI có thể có một số tương đương với các nhận xét C# XML, nhưng tôi không biết về nó.

Answer 2

Bạn có thể sử dụng kiểu nhận xét tương thích với Javadoc, nhập nhận xét bằng tay hoặc sử dụng công cụ bổ trợ của tôi, Atomineer Pro Documentation để tận dụng tối đa công việc. Sau đó, để tạo tài liệu bên ngoài, hãy sử dụng doxygen, giúp đọc javadoc một cách vui vẻ.

Cách khác là (như Jon đã nói) để sử dụng các nhận xét định dạng XmlDoc, có thể được sử dụng bởi Visual Studio (cho chú giải công cụ intellisense), Atomineer, Sandcastle và Doxygen. Đó là một định dạng ít người có thể đọc được, nhưng mang lại cho bạn những lợi thế đáng kể trong môi trường Visual Studio, vì vậy nó linh hoạt hơn một chút.

Cả hai phương pháp sẽ làm việc cho C#, C++, C (mặc dù C# hoạt động tốt hơn ở phía bên IntelliSense của sự vật)