Khi sử dụng lắp ráp bên ngoài đi kèm với tệp tài liệu XML, làm thế nào để tôi có được studio trực quan để tìm?Cách sử dụng các tệp tài liệu XML
Khi có tệp tài liệu XML, có tệp chương trình hoặc tệp biến đổi xml hay thứ gì đó tôi có thể sử dụng để xem xét một cách tốt đẹp không? Không nhất thiết phải phức tạp như các MSDN xem tài liệu thingy, nhưng ít nhất một cái gì đó đẹp hơn xml tinh khiết ...
1: bạn chỉ cần thả nó vào cùng một thư mục với tên dll
2: hiện nó cần phải được duy trì? Để sử dụng "trực tiếp", cả IDE VS lẫn "phản xạ" cho phép bạn xem lại tài liệu (chống lại các loại/thành viên/v.v.). Có những công cụ để biến đổi nó, nhưng tôi chưa bao giờ làm phiền. Sandcastle có thể đáng xem, nhưng nó không bao giờ tốt đẹp với tôi ;-p
trả lời cho câu hỏi đầu tiên của bạn: xml nên có tên tương tự như lắp ráp và ngay bên cạnh cho nó. Vì vậy, nếu bạn có một hội đồng gọi là Svish.dll thì tệp tài liệu của bạn phải là Svish.xml và nằm trong cùng một thư mục.
1) Tệp tài liệu phải có cùng tên với tên lắp ráp, với phần mở rộng thêm '.xml', và nằm trong cùng một thư mục như là hội đồng tương ứng của nó. Vì vậy, ví dụ, bạn có một 'MyCompany.MyNamespace.dll' và một tập tin 'MyCompany.MyNamespace.dll.xml' trong cùng một thư mục.
2) NDOC có thể tạo ra một số định dạng tài liệu hướng dẫn.
Trong các ví dụ tôi đã thấy, và điều đó có hiệu quả đối với tôi, nó giống như trong câu trả lời của Marc Gravell. Đó là: 'MyCompany.MyNamespace.xml' không phải' MyCompany.MyNamespace.dll.xml'. –
Về 2: Bạn có thể xem một "phiên bản đẹp" của tài liệu bằng cách sử dụng trình duyệt Object (Xem> Object Browser (Ctrl W + J)) và sau đó duyệt đến lớp để xem xét tài liệu. Tôi đã sử dụng Trình duyệt đối tượng để xem lại tài liệu của riêng mình vì nó dễ đọc hơn so với các tệp xml hoặc các nhận xét.
Tôi đã cố gắng để thả nó trong cùng một thư mục, nhưng nó không muốn nhặt nó lên có vẻ như. Tôi vẫn không nhận được tài liệu. – Svish
Các tệp phải là Foo.Bar.dll và Foo.Bar.xml (ví dụ); bạn có chắc chắn rằng bạn đang tham khảo dll từ vị trí đó? Và bạn có chắc đó là một tập tin bình luận? –
Có vẻ như tôi đã phải khởi động lại VS để nó hoạt động ... có lệnh nào để xây dựng lại/đọc lại tài liệu hay một cái gì đó có thể? – Svish