Skip to content

Commit 42b412a

Browse files
Add a note explaining the XXXX in the rule number to InternalsVisibleTo page (#44240)
1 parent d5eaad9 commit 42b412a

File tree

4 files changed

+12
-0
lines changed

4 files changed

+12
-0
lines changed

docs/fundamentals/code-analysis/includes/api-surface.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,6 @@ You can configure which parts of your codebase to run this rule on, based on the
55
```ini
66
dotnet_code_quality.CAXXXX.api_surface = private, internal
77
```
8+
9+
> [!NOTE]
10+
> Replace the `XXXX` part of `CAXXXX` with the ID of the applicable rule.

docs/fundamentals/code-analysis/includes/excluded-symbol-names.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ You can exclude specific symbols, such as types and methods, from analysis. For
66
dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType
77
```
88

9+
> [!NOTE]
10+
> Replace the `XXXX` part of `CAXXXX` with the ID of the applicable rule.
11+
912
Allowed symbol name formats in the option value (separated by `|`):
1013

1114
- Symbol name only (includes all symbols with the name, regardless of the containing type or namespace).

docs/fundamentals/code-analysis/includes/excluded-type-names-with-derived-types.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ You can exclude specific types and their derived types from analysis. For exampl
66
dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType
77
```
88

9+
> [!NOTE]
10+
> Replace the `XXXX` part of `CAXXXX` with the ID of the applicable rule.
11+
912
Allowed symbol name formats in the option value (separated by `|`):
1013

1114
- Type name only (includes all types with the name, regardless of the containing type or namespace).

docs/fundamentals/code-analysis/includes/ignore-ivt.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,7 @@ By default, this rule is disabled if the assembly being analyzed uses <xref:Syst
66
dotnet_code_quality.CAXXXX.ignore_internalsvisibleto = true
77
```
88

9+
> [!NOTE]
10+
> Replace the `XXXX` part of `CAXXXX` with the ID of the applicable rule.
11+
912
This option is available starting in .NET 8.

0 commit comments

Comments
 (0)