You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: documentation/Configuration.md
+38Lines changed: 38 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -454,6 +454,44 @@ The following example shows a configuration file which requires developers to do
454
454
}
455
455
```
456
456
457
+
### Documentation Culture
458
+
459
+
Some documentation rules require summary texts to start with specific strings. To allow teams to document their code in their native language, **stylecop.json** contains the `documentationCulture` property.
460
+
461
+
| Property | Default Value | Summary |
462
+
| --- | --- | --- |
463
+
|`documentationCulture`|`"en-US"`| Specifies the culture or language to be used for certain documentation texts. |
464
+
465
+
This property affects the behavior of the following rules which report incorrect documentation.
466
+
467
+
*[SA1623 Property summary documentation must match accessors](SA1623.md)
468
+
*[SA1624 Property summary documentation must omit set accessor with restricted access](SA1624.md)
469
+
*[SA1642 Constructor summary documentation must begin with standard text](SA1642.md)
470
+
*[SA1643 Destructor summary documentation must begin with standard text](SA1643.md)
471
+
472
+
> :memo: The default value for `documentationCulture` is fixed instead of reflecting the user's system language. This is to ensure that different developers working on the same project always use the same value.
473
+
474
+
The following values are currently supported. Unsupported values will automatically fall back to the default value.
475
+
476
+
*`"de-DE"`
477
+
*`"en-GB"`
478
+
*`"en-US"`
479
+
*`"es-MX"`
480
+
*`"fr-FR"`
481
+
*`"pl-PL"`
482
+
*`"pt-BR"`
483
+
*`"ru-RU"`
484
+
485
+
```json
486
+
{
487
+
"settings": {
488
+
"documentationRules": {
489
+
"documentationCulture": "de-DE"
490
+
}
491
+
}
492
+
}
493
+
```
494
+
457
495
### File naming conventions
458
496
459
497
The `fileNamingConvention` property will determine how the [SA1649 File name must match type name](SA1649.md) analyzer will check file names.
0 commit comments