From f692c2bb3b267e790793b889e5ec61b890334a5e Mon Sep 17 00:00:00 2001 From: kurnakovv Date: Tue, 7 Oct 2025 14:41:03 +0900 Subject: [PATCH 1/2] Add code example for CA1700 rule (#48932) --- .../code-analysis/quality-rules/ca1700.md | 6 +++++ .../snippets/csharp/all-rules/ca1700.cs | 22 +++++++++++++++++++ 2 files changed, 28 insertions(+) create mode 100644 docs/fundamentals/code-analysis/quality-rules/snippets/csharp/all-rules/ca1700.cs diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1700.md b/docs/fundamentals/code-analysis/quality-rules/ca1700.md index f87c858c3aa69..cf40d421715a4 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1700.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1700.md @@ -10,6 +10,8 @@ helpviewer_keywords: - CA1700 author: gewarren ms.author: gewarren +dev_langs: +- CSharp --- # CA1700: Do not name enum values 'Reserved' @@ -43,6 +45,10 @@ In a limited number of cases the addition of a member is a breaking change even To fix a violation of this rule, remove or rename the member. +## Example + +:::code language="csharp" source="snippets/csharp/all-rules/ca1700.cs" id="snippet1"::: + ## When to suppress warnings It is safe to suppress a warning from this rule for a member that is currently used or for libraries that have previously shipped. diff --git a/docs/fundamentals/code-analysis/quality-rules/snippets/csharp/all-rules/ca1700.cs b/docs/fundamentals/code-analysis/quality-rules/snippets/csharp/all-rules/ca1700.cs new file mode 100644 index 0000000000000..3c30e4d5241dc --- /dev/null +++ b/docs/fundamentals/code-analysis/quality-rules/snippets/csharp/all-rules/ca1700.cs @@ -0,0 +1,22 @@ +namespace ca1700 +{ + // + // This class violates the rule. + public enum BadPaymentStatus + { + Pending = 0, + Completed = 1, + ReservedError = 2, + Reserved = 3, + } + + // This class satisfies the rule. + public enum GoodPaymentStatus + { + Pending = 0, + Completed = 1, + Error = 2, + Unknown = 3, + } + // +} From bcd86ec0f264c16db88d3c5e157d2a5f9d2954fa Mon Sep 17 00:00:00 2001 From: kurnakovv Date: Tue, 7 Oct 2025 16:26:29 +0900 Subject: [PATCH 2/2] Fix class -> enum for comments (#48932) --- .../quality-rules/snippets/csharp/all-rules/ca1700.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/fundamentals/code-analysis/quality-rules/snippets/csharp/all-rules/ca1700.cs b/docs/fundamentals/code-analysis/quality-rules/snippets/csharp/all-rules/ca1700.cs index 3c30e4d5241dc..3989315053bf6 100644 --- a/docs/fundamentals/code-analysis/quality-rules/snippets/csharp/all-rules/ca1700.cs +++ b/docs/fundamentals/code-analysis/quality-rules/snippets/csharp/all-rules/ca1700.cs @@ -1,7 +1,7 @@ namespace ca1700 { // - // This class violates the rule. + // This enum violates the rule. public enum BadPaymentStatus { Pending = 0, @@ -10,7 +10,7 @@ public enum BadPaymentStatus Reserved = 3, } - // This class satisfies the rule. + // This enum satisfies the rule. public enum GoodPaymentStatus { Pending = 0,