dotnet / dotnet/docs

The doc for CA1506 (and presumably related warnings) is succinct to the point of being hard to follow

Đang mở
#32,905 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
dotnet-fundamentals/svc
Ngôn ngữ chính
Không có dữ liệu ngôn ngữ
Star
4.8k
Fork
6.1k
Merge trung bình
15 giờ 21 phút
Pull request đã merge (30 ngày)
370

Mô tả

**Issue description**

A customer reported on the internal StackOverflow page that the doc page for CA1506 was inaccurate and useless. Having looked it over, I think its suggestions on how to suppress warnings seem accurate but are very succinct to the point where it is difficult for even an experienced software engineer to follow unless they work in developer tools. Furthermore, having links to other doc pages makes it harder to know what is important.

One additional way to suppress these warnings is adding `CA1506` to your MSBuild project or specifying it on the command line or in a Directory.Build.props, etc. That option was not mentioned in the doc page.

[This](https://stackoverflow.microsoft.com/questions/334729) is the StackOverflow post I referred to.

---
#### Document Details

⚠ *Do not edit this section. It is required for learn.microsoft.com ➟ GitHub issue linking.*

* ID: d6bc7ccb-aab7-7e71-f5c5-82cd8fbef17f
* Version Independent ID: b5a70070-37a7-68ee-3ef4-969c961f4486
* Content: [CA1506: Avoid excessive class coupling (code analysis) - .NET](https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/ca1506)
* Content Source: [docs/fundamentals/code-analysis/quality-rules/ca1506.md](https://github.com/dotnet/docs/blob/main/docs/fundamentals/code-analysis/quality-rules/ca1506.md)
* Product: **dotnet-fundamentals**
* GitHub Login: @gewarren
* Microsoft Alias: **gewarren**

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Open docs/fundamentals/code-analysis/quality-rules/ca1506.md and read the current guidance and linked suppression pages. Clarify the existing suppression instructions for newcomers, including the NoWarn option in an MSBuild project, command line, or Directory.Build.props. Done means the CA1506 page is accurate, easier to follow, and covers the reported suppression method.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Đặc tả rõ ràng
Mức phù hợp với người mới
35/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.