Added more explanations to .editorconfig

OpenRA · Jan 12, 2022 · 3d14c3b · 3d14c3b
1 parent 82aa68f
commit 3d14c3b
Showing 1 changed file with 12 additions and 12 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -58,41 +58,41 @@ dotnet_naming_symbols.parameters.applicable_kinds = parameter
 
 # Naming rules:
 
-dotnet_naming_rule.non_field_members_should_be_pascal_case.severity = warning
+dotnet_naming_rule.non_field_members_should_be_pascal_case.severity = warning                           # IDE1006, IDE-only counterpart of StyleCopAnalyzers - SA1300: ElementMustBeginWithUpperCaseLetter.
 dotnet_naming_rule.non_field_members_should_be_pascal_case.symbols = non_field_members
 dotnet_naming_rule.non_field_members_should_be_pascal_case.style = pascal_case
 
-dotnet_naming_rule.static_private_or_internal_field_should_be_pascal_case.severity = none
+dotnet_naming_rule.static_private_or_internal_field_should_be_pascal_case.severity = none               # IDE1006, IDE-only counterpart of StyleCopAnalyzers - SA1311: StaticReadonlyFieldsMustBeginWithUpperCaseLetter.
 dotnet_naming_rule.static_private_or_internal_field_should_be_pascal_case.symbols = static_private_or_internal_field
 dotnet_naming_rule.static_private_or_internal_field_should_be_pascal_case.style = pascal_case
 
-dotnet_naming_rule.const_private_field_should_be_pascal_case.severity = warning
+dotnet_naming_rule.const_private_field_should_be_pascal_case.severity = warning                         # IDE1006, IDE-only counterpart of StyleCopAnalyzers - SA1303: ConstFieldNamesMustBeginWithUpperCaseLetter.
 dotnet_naming_rule.const_private_field_should_be_pascal_case.symbols = const_private_field
 dotnet_naming_rule.const_private_field_should_be_pascal_case.style = pascal_case
 
 dotnet_naming_rule.const_private_or_internal_field_should_be_pascal_case.severity = warning
 dotnet_naming_rule.const_private_or_internal_field_should_be_pascal_case.symbols = internal_field
 dotnet_naming_rule.const_private_or_internal_field_should_be_pascal_case.style = pascal_case
 
-dotnet_naming_rule.private_or_internal_field_should_be_camel_case.severity = warning
+dotnet_naming_rule.private_or_internal_field_should_be_camel_case.severity = warning                    # IDE1006, IDE-only counterpart of StyleCopAnalyzers - SA1306: FieldNamesMustBeginWithLowerCaseLetter.
 dotnet_naming_rule.private_or_internal_field_should_be_camel_case.symbols = private_or_internal_field
 dotnet_naming_rule.private_or_internal_field_should_be_camel_case.style = camel_case
 
-dotnet_naming_rule.parameters.severity = warning
+dotnet_naming_rule.parameters.severity = warning                                                        # IDE1006, IDE-only counterpart of StyleCopAnalyzers - SA1313: ParameterNamesMustBeginWithLowerCaseLetter.
 dotnet_naming_rule.parameters.symbols = parameters
 dotnet_naming_rule.parameters.style = camel_case
 
 # Formatting:
 
-csharp_space_after_colon_in_inheritance_clause = true             # Also handled by StyleCopAnalyzers - SA1024: ColonsMustBeSpacedCorrectly.
-csharp_space_before_colon_in_inheritance_clause = true            # Also handled by StyleCopAnalyzers - SA1024: ColonsMustBeSpacedCorrectly.
-csharp_space_after_keywords_in_control_flow_statements = true     # Also handled by StyleCopAnalyzers - SA1000: KeywordsMustBeSpacedCorrectly.
+csharp_space_after_colon_in_inheritance_clause = true                   # Also handled by StyleCopAnalyzers - SA1024: ColonsMustBeSpacedCorrectly.
+csharp_space_before_colon_in_inheritance_clause = true                  # Also handled by StyleCopAnalyzers - SA1024: ColonsMustBeSpacedCorrectly.
+csharp_space_after_keywords_in_control_flow_statements = true           # Also handled by StyleCopAnalyzers - SA1000: KeywordsMustBeSpacedCorrectly.
 
-csharp_preserve_single_line_blocks = true                         # Leave code block on single line.
-csharp_preserve_single_line_statements = true                     # Leave statements and member declarations on the same line.
+csharp_preserve_single_line_blocks = true                               # Leave code block on single line.
+csharp_preserve_single_line_statements = true                           # Leave statements and member declarations on the same line.
 
-dotnet_style_predefined_type_for_member_access = true             # Also handled by StyleCopAnalyzers - SA1121: UseBuiltInTypeAlias. Also by IDE0049, it seems.
-dotnet_style_predefined_type_for_locals_parameters_members = true # Also handled by StyleCopAnalyzers - SA1121: UseBuiltInTypeAlias. Also by IDE0049, it seems.
+dotnet_style_predefined_type_for_member_access = true                   # IDE0049, IDE-only counterpart of StyleCopAnalyzers - SA1121: UseBuiltInTypeAlias.
+dotnet_style_predefined_type_for_locals_parameters_members = true       # IDE0049, IDE-only counterpart of StyleCopAnalyzers - SA1121: UseBuiltInTypeAlias.
 
 # Others: