2013-10-29 33 views
11

Tôi đã kế thừa một loạt mã C#. Đối với một vài định nghĩa phương pháp, tôi tìm thấy ///<exclude/> là XMLDoc duy nhất ở phía trước nó. Tôi đã thử với Google ý nghĩa của điều đó nhưng không thành công. Ai đó có thể giải thích điều đó có nghĩa là gì không?"/// <exclude/>" có nghĩa là gì?

Trả lời

14

Trong ít nhất là NDoc, điều đó có nghĩa là tài liệu XML cho thành viên này sẽ bị loại trừ. Từ số documentation:

Thẻ <exclude/> chỉ đạo NDoc loại trừ mục hiện tại khỏi tài liệu.

Nó không rõ ràng cho dù đây là NDoc cụ thể, nhưng nó cũng dường như được hỗ trợ bởi Sandcastle (trong đó là trong Sandcastle XML comments guide).

+0

@Hanky ​​웃 Panky: Để trả lời câu hỏi: Đó là Jon Skeet (giai đoạn)! ;-) – Andreas

+0

Tôi không có bằng chứng cho thấy dự án này sử dụng NDoc. Có lẽ ai đó trong quá khứ đã cố gắng bắt đầu sử dụng NDoc. Nếu không có cách sử dụng khác được biết đến của điều này, tôi lấy câu trả lời của Jon. Cảm ơn! – Andreas

2

Từ Sandcastle Help File Builderdocumentation:

Một namespace được loại trừ qua tài sản Namespace Tóm tắt hoặc một mục được loại trừ vì bình luận XML của nó bao gồm một < loại trừ/> thẻ. Thông tin này được tự động hợp nhất với bộ lọc API cài đặt. Để thay đổi các mục này, bạn sẽ cần sử dụng thuộc tính Không gian tên tóm tắt hoặc xóa thẻ khỏi các nhận xét XML của mục.

Một trả lời chính thức:

A way to exclude documentation?

Và thêm thông tin về các hành vi:

Problems with missing members and tag

+1

Cảm ơn câu trả lời của bạn. – Andreas