Merge pull request #6477 from mavasani/Doc_CA1509

Add documentation for CA1509 (Invalid entry in code metrics configura…

Author: denrea

docs/code-quality/ca1509.md

@@ -0,0 +1,85 @@
+---
+title: 'CA1509: Invalid entry in code metrics configuration file'
+ms.date: 04/28/2020
+ms.topic: reference
+f1_keywords:
+- CA1509
+- CodeMetricsAnalyzer
+helpviewer_keywords:
+- CodeMetricsAnalyzer
+- CA1509
+author: mavasani
+ms.author: mavasani
+manager: jillfra
+ms.workload:
+- multiple
+---
+# CA1509: Invalid entry in code metrics configuration file
+
+|||
+|-|-|
+|TypeName|CodeMetricsAnalyzer|
+|CheckId|CA1509|
+|Category|Microsoft.Maintainability|
+|Breaking change|Non-Breaking|
+
+## Cause
+
+Code metrics rules, such as [CA1501](ca1501.md), [CA1502](ca1502.md), [CA1505](ca1505.md) and [CA1506](ca1506.md), supplied a configuration file named `CodeMetricsConfig.txt` that has an invalid entry.
+
+## Rule description
+
+[FxCop analyzers](https://www.nuget.org/packages/Microsoft.CodeAnalysis.FxCopAnalyzers) implementation of [code metrics](code-metrics-values.md) analysis rules allow end users to supply an [additional file](https://github.com/dotnet/roslyn/blob/release/dev16.6/docs/analyzers/Using%20Additional%20Files.md) named `CodeMetricsConfig.txt`. This file contains entries to configure code metric thresholds for analysis. Following rules are configurable in this file:
+
+- [CA1501: Avoid excessive inheritance](ca1501.md)
+- [CA1502: Avoid excessive complexity](ca1502.md)
+- [CA1505: Avoid unmaintainable code](ca1505.md)
+- [CA1506: Avoid excessive class coupling](ca1506.md)
+
+This configuration file expects each entry to be in following format:
+
+```ini
+'RuleId'(Optional 'SymbolKind'): 'Threshold'
+```
+
+- Valid values for 'RuleId' are `CA1501`, `CA1502`, `CA1505` and `CA1506`.
+- Valid values for optional 'SymbolKind' are `Assembly`, `Namespace`, `Type`, `Method`, `Field`, `Event`, and `Property`.
+- Valid values for 'Threshold' are non-negative integers.
+- Lines starting with '#' are treated as comment lines
+
+For example, the following is a valid configuration file:
+
+```ini
+# Comment text
+
+CA1501: 1
+
+CA1502(Type): 4
+CA1502(Method): 2
+```
+
+An invalid entry in this configuration file is flagged with the `CA1509` diagnostic.
+
+> [!NOTE]
+> Rule CA1509 is not available in legacy analysis. It was first introduced in [FxCop analyzers](https://www.nuget.org/packages/Microsoft.CodeAnalysis.FxCopAnalyzers) version 2.9.6.
+
+
+## How to fix violations
+
+To fix a violation of this rule, make sure the invalid entry in `CodeMetricsConfig.txt` gets the required format.
+
+## When to suppress warnings
+
+Do not suppress violations of this rule.
+
+## Related rules
+
+- [CA1501: Avoid excessive inheritance](ca1501.md)
+- [CA1502: Avoid excessive complexity](ca1502.md)
+- [CA1505: Avoid unmaintainable code](ca1505.md)
+- [CA1506: Avoid excessive class coupling](ca1506.md)
+
+## See also
+
+- [Maintainability warnings](maintainability-warnings.md)
+- [Measure complexity and maintainability of managed code](code-metrics-values.md)

docs/code-quality/code-analysis-warnings-for-managed-code-by-checkid.md

@@ -107,6 +107,7 @@ f1_keywords:
 - CA1506
 - CA1507
 - CA1508
+- CA1509
 - CA1600
 - CA1601
 - CA1700
@@ -377,6 +378,7 @@ The following table lists Code Analysis warnings for managed code by the CheckId
 | CA1506 | [CA1506: Avoid excessive class coupling](../code-quality/ca1506.md) | This rule measures class coupling by counting the number of unique type references that a type or method contains. |
 | CA1507 | [CA1507: Use nameof in place of string](../code-quality/ca1507.md) | A string literal is used as an argument where a `nameof` expression could be used. |
 | CA1508 | [CA1508: Avoid dead conditional code](../code-quality/ca1508.md) | A method has conditional code that always evaluates to `true` or `false` at runtime. This leads to dead code in the `false` branch of the condition. |
+| CA1509 | [CA1509: Invalid entry in code metrics configuration file](../code-quality/ca1509.md) | Code metrics rules, such as [CA1501](ca1501.md), [CA1502](ca1502.md), [CA1505](ca1505.md) and [CA1506](ca1506.md), supplied a configuration file named `CodeMetricsConfig.txt` that has an invalid entry. |
 | CA1600 | [CA1600: Do not use idle process priority](../code-quality/ca1600.md) | Do not set process priority to Idle. Processes that have System.Diagnostics.ProcessPriorityClass.Idle will occupy the CPU when it would otherwise be idle, and will therefore block standby. |
 | CA1601 | [CA1601: Do not use timers that prevent power state changes](../code-quality/ca1601.md) | Higher-frequency periodic activity will keep the CPU busy and interfere with power-saving idle timers that turn off the display and hard disks. |
 | CA1700 | [CA1700: Do not name enum values 'Reserved'](../code-quality/ca1700.md) | This rule assumes that an enumeration member that has a name that contains "reserved" is not currently used but is a placeholder to be renamed or removed in a future version. Renaming or removing a member is a breaking change. |

docs/code-quality/maintainability-warnings.md

@@ -31,6 +31,7 @@ Maintainability warnings support library and application maintenance.
 | [CA1506: Avoid excessive class coupling](../code-quality/ca1506.md) | This rule measures class coupling by counting the number of unique type references that a type or method contains. |
 | [CA1507: Use nameof in place of string](../code-quality/ca1507.md) | A string literal is used as an argument where a `nameof` expression could be used. |
 | [CA1508: Avoid dead conditional code](../code-quality/ca1508.md) | A method has conditional code that always evaluates to `true` or `false` at runtime. This leads to dead code in the `false` branch of the condition. |
+| [CA1509: Invalid entry in code metrics configuration file](../code-quality/ca1509.md) | Code metrics rules, such as [CA1501](ca1501.md), [CA1502](ca1502.md), [CA1505](ca1505.md) and [CA1506](ca1506.md), supplied a configuration file named `CodeMetricsConfig.txt` that has an invalid entry. |
 
 ## See also
 

docs/code-quality/toc.yml

@@ -432,6 +432,8 @@
           href: ca1507.md
         - name: "CA1508: Avoid dead conditional code"
           href: ca1508.md
+        - name: "CA1509: Invalid entry in code metrics configuration file"
+          href: ca1509.md
       - name: Mobility warnings
         items:
         - name: Overview