Optionen für Codestilregeln
Sie können einen konsistenten Codestil in Ihrer Codebasis definieren und beibehalten, indem Sie .NET-Codestilregeln und die zugehörigen Optionen in einer Konfigurationsdatei definieren. Diese Regeln werden durch verschiedene Entwicklungs-IDEs (z. B. Visual Studio) verwendet, während Sie Ihren Code bearbeiten. Für .NET-Projekte können diese Regeln auch zum Erstellungszeitpunkt erzwungen werden. Sie können einzelne .NET-Codierungsregeln aktivieren oder deaktivieren und konfigurieren, inwieweit die einzelnen Regeln über einen Schweregrad erzwungen werden sollen.
Tipp
Wenn Sie Codestiloptionen in einer EditorConfig-Datei definieren, konfigurieren Sie damit, wie die Codestil-Analysetools Ihren Code analysieren sollen. Die EditorConfig-Datei ist die Konfigurationsdatei für diese Analysetools.
Codestiloptionen können auch in Visual Studio im Dialogfeld Text-Editor-Optionen festgelegt werden. Dies sind benutzerspezifische Optionen, die nur bei der Bearbeitung in Visual Studio beachtet werden. Diese Optionen werden zur Erstellungszeit oder von anderen IDEs nicht beachtet. Wenn das Projekt oder die Projektmappe, das/die in Visual Studio geöffnet wurde, über eine EditorConfig-Datei verfügt, besitzen die Optionen aus der EditorConfig-Datei außerdem Vorrang. In Visual Studio unter Windows können Sie auch eine EditorConfig-Datei aus Ihren Text-Editor-Optionen generieren. Wählen Sie Extras>Optionen>Text-Editor> [C# oder Basic] >Codestil>Allgemein aus, und klicken Sie dann auf EDITORCONFIG-Datei aus Einstellungen generieren. Weitere Informationen finden Sie unter Codeformateinstellungen.
Codestilregeln werden in die folgenden Unterkategorien unterteilt:
Jede dieser Unterkategorien definiert eine eigene Syntax zum Angeben von Optionen. Weitere Informationen zu diesen Regeln und den entsprechenden Optionen finden Sie in der Referenz zu Codestilregeln.
EDITORCONFIG-Beispieldatei
Zur Erleichterung Ihres Einstiegs finden Sie im Folgenden eine EDITORCONFIG-Beispieldatei mit den Standardoptionen.
Hinweis
Die in dieser Datei verwendete knappe Syntax, bei der der Schweregrad nach dem Optionswert für Sprachregeln angegeben wird (z. B. dotnet_style_readonly_field = true:suggestion), wird nur von Visual Studio vollständig verstanden. Compiler verstehen das :<severity-level>-Suffix nicht und ignorieren es, wenn Sie Ihren Code über die Befehlszeile kompilieren. Um den Schweregrad auf eine Weise festzulegen, die sowohl von Visual Studio als auch von den C#- und Visual Basic-Compilern verstanden wird, legen Sie den Schweregrad für die Regel, die die Option enthält, mithilfe der folgenden Syntax fest:
dotnet_diagnostic.<rule-ID>.severity = <severity-level>
Weitere Informationen finden Sie unter Optionsformat.
Tipp
- In Visual Studio können Sie Ihrem Projekt im Dialogfeld Neues Element hinzufügen die folgende .NET-EDITORCONFIG-Standarddatei hinzufügen. Ausführliche Schritte finden Sie unter Hinzufügen und Entfernen von EDITORCONFIG-Dateien.
- Informationen zur Verwendung von EDITORCONFIG-Dateien in Visual Studio für Mac finden Sie unter Erstellen und Bearbeiten einer benutzerdefinierten EDITORCONFIG-Datei.
- Für Visual Studio Code können Sie das EditorConfig-Plug-In für VS Code verwenden, um Benutzer-/Arbeitsbereichseinstellungen mit den Einstellungen in EDITORCONFIG-Dateien zu überschreiben.
###############################
# Core EditorConfig Options #
###############################
root = true
# All files
[*]
indent_style = space
# XML project files
[*.{csproj,vbproj,vcxproj,vcxproj.filters,proj,projitems,shproj}]
indent_size = 2
# XML config files
[*.{props,targets,ruleset,config,nuspec,resx,vsixmanifest,vsct}]
indent_size = 2
# Code files
[*.{cs,csx,vb,vbx}]
indent_size = 4
insert_final_newline = true
charset = utf-8-bom
###############################
# .NET Coding Conventions #
###############################
[*.{cs,vb}]
# Organize usings
dotnet_sort_system_directives_first = true
# this. preferences
dotnet_style_qualification_for_field = false:silent
dotnet_style_qualification_for_property = false:silent
dotnet_style_qualification_for_method = false:silent
dotnet_style_qualification_for_event = false:silent
# Language keywords vs BCL types preferences
dotnet_style_predefined_type_for_locals_parameters_members = true:silent
dotnet_style_predefined_type_for_member_access = true:silent
# Parentheses preferences
dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity:silent
dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:silent
dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:silent
dotnet_style_parentheses_in_other_operators = never_if_unnecessary:silent
# Modifier preferences
dotnet_style_require_accessibility_modifiers = for_non_interface_members:silent
dotnet_style_readonly_field = true:suggestion
# Expression-level preferences
dotnet_style_object_initializer = true:suggestion
dotnet_style_collection_initializer = true:suggestion
dotnet_style_explicit_tuple_names = true:suggestion
dotnet_style_null_propagation = true:suggestion
dotnet_style_coalesce_expression = true:suggestion
dotnet_style_prefer_is_null_check_over_reference_equality_method = true:silent
dotnet_style_prefer_inferred_tuple_names = true:suggestion
dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
dotnet_style_prefer_auto_properties = true:silent
dotnet_style_prefer_conditional_expression_over_assignment = true:silent
dotnet_style_prefer_conditional_expression_over_return = true:silent
###############################
# Naming Conventions #
###############################
# Style Definitions
dotnet_naming_style.pascal_case_style.capitalization = pascal_case
# Use PascalCase for constant fields
dotnet_naming_rule.constant_fields_should_be_pascal_case.severity = suggestion
dotnet_naming_rule.constant_fields_should_be_pascal_case.symbols = constant_fields
dotnet_naming_rule.constant_fields_should_be_pascal_case.style = pascal_case_style
dotnet_naming_symbols.constant_fields.applicable_kinds = field
dotnet_naming_symbols.constant_fields.applicable_accessibilities = *
dotnet_naming_symbols.constant_fields.required_modifiers = const
###############################
# C# Coding Conventions #
###############################
[*.cs]
# var preferences
csharp_style_var_for_built_in_types = true:silent
csharp_style_var_when_type_is_apparent = true:silent
csharp_style_var_elsewhere = true:silent
# Expression-bodied members
csharp_style_expression_bodied_methods = false:silent
csharp_style_expression_bodied_constructors = false:silent
csharp_style_expression_bodied_operators = false:silent
csharp_style_expression_bodied_properties = true:silent
csharp_style_expression_bodied_indexers = true:silent
csharp_style_expression_bodied_accessors = true:silent
# Pattern matching preferences
csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion
csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
# Null-checking preferences
csharp_style_throw_expression = true:suggestion
csharp_style_conditional_delegate_call = true:suggestion
# Modifier preferences
csharp_preferred_modifier_order = public,private,protected,internal,file,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,required,volatile,async:suggestion
# Expression-level preferences
csharp_prefer_braces = true:silent
csharp_style_deconstructed_variable_declaration = true:suggestion
csharp_prefer_simple_default_expression = true:suggestion
csharp_style_prefer_local_over_anonymous_function = true:suggestion
csharp_style_inlined_variable_declaration = true:suggestion
###############################
# C# Formatting Rules #
###############################
# New line preferences
csharp_new_line_before_open_brace = all
csharp_new_line_before_else = true
csharp_new_line_before_catch = true
csharp_new_line_before_finally = true
csharp_new_line_before_members_in_object_initializers = true
csharp_new_line_before_members_in_anonymous_types = true
csharp_new_line_between_query_expression_clauses = true
# Indentation preferences
csharp_indent_case_contents = true
csharp_indent_switch_labels = true
csharp_indent_labels = flush_left
# Space preferences
csharp_space_after_cast = false
csharp_space_after_keywords_in_control_flow_statements = true
csharp_space_between_method_call_parameter_list_parentheses = false
csharp_space_between_method_declaration_parameter_list_parentheses = false
csharp_space_between_parentheses = false
csharp_space_before_colon_in_inheritance_clause = true
csharp_space_after_colon_in_inheritance_clause = true
csharp_space_around_binary_operators = before_and_after
csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
csharp_space_between_method_call_name_and_opening_parenthesis = false
csharp_space_between_method_call_empty_parameter_list_parentheses = false
# Wrapping preferences
csharp_preserve_single_line_statements = true
csharp_preserve_single_line_blocks = true
###############################
# VB Coding Conventions #
###############################
[*.vb]
# Modifier preferences
visual_basic_preferred_modifier_order = Partial,Default,Private,Protected,Public,Friend,NotOverridable,Overridable,MustOverride,Overloads,Overrides,MustInherit,NotInheritable,Static,Shared,Shadows,ReadOnly,WriteOnly,Dim,Const,WithEvents,Widening,Narrowing,Custom,Async:suggestion
Siehe auch
- Referenz zu Regeln für die Analyse des Codeformats
- Erzwingen von Codestilregeln beim Buildvorgang
- Schnelle Aktionen in Visual Studio
- Erstellen von portierbaren benutzerdefinierten Editor-Optionen in Visual Studio
- EDITORCONFIG-Datei für die .NET Compiler Platform „Roslyn“
- .NET Runtime: EDITORCONFIG-Datei
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für