Tôi có một dự án với hơn 500 Missing XML Comment
cảnh báo. Tôi biết tôi có thể xóa tính năng Nhận xét XML hoặc dán các đoạn nhận xét trống ở mọi nơi, nhưng tôi thích một giải pháp chung hơn, nơi tôi có thể thực hiện một thay đổi để vô hiệu hóa tất cả các cảnh báo thuộc loại này.
Những gì tôi làm bây giờ là đặt
///<Summary>
///
///</Summary>
hoặc là
#pragma warning disable 1591
chỉ tò mò nếu nó sẽ có thể.
public
không có lý do chính đáng. Trong trường hợp đó, một cách khắc phục dễ dàng (và theo ý kiến của tôi là tốt) là chỉ cần loại bỏ từ public
(hoặc thay thế nó bằng một internal
từ khóa dư thừa , tùy thuộc vào kiểu ưa thích) từ loại kèm theo ngoài cùng. Sau đó, tất cả các cảnh báo CS1591 về loại này và các thành viên của nó biến mất. Tất nhiên bạn vẫn có thể phải giữ một số loại public
. Nhưng trong trường hợp đó, công bằng là bạn yêu cầu ghi lại các phần công khai của họ đúng cách.