Opcje reguły stylu kodu

Możesz zdefiniować i zachować spójny styl kodu w bazie kodu, definiując reguły stylu kodu platformy .NET i skojarzone z nimi opcje w pliku konfiguracji. Te reguły są udostępniane przez różne środowiska IDE programowania, takie jak Visual Studio, podczas edytowania kodu. W przypadku projektów platformy .NET te reguły można również wymuszać w czasie kompilacji. Możesz włączyć lub wyłączyć poszczególne reguły i skonfigurować stopień, w jakim każda reguła ma być wymuszana, za pośrednictwem poziomu ważności.

Napiwek

  • Podczas definiowania opcji stylu kodu w pliku EditorConfig konfigurujesz sposób analizowania kodu przez analizatory stylów kodu. Plik EditorConfig jest plikiem konfiguracji dla tych analizatorów.

  • Opcje stylu kodu można również ustawić w programie Visual Studio w oknie dialogowym Opcje edytora tekstu. Są to opcje dla poszczególnych użytkowników, które są przestrzegane tylko podczas edytowania w programie Visual Studio. Te opcje nie są uwzględniane w czasie kompilacji ani przez inne środowiska IDE. Ponadto jeśli projekt lub rozwiązanie otwarte w programie Visual Studio ma plik EditorConfig, opcje z pliku EditorConfig mają pierwszeństwo. W programie Visual Studio w systemie Windows można również wygenerować plik EditorConfig z opcji edytora tekstu. Wybierz pozycję Narzędzia>Opcje>Edytor> tekstu [C# lub Podstawowy]> Styl>kodu Ogólne, a następnie kliknij pozycję Generuj plik editorconfig z ustawień. Aby uzyskać więcej informacji, zobacz Preferencje stylu kodu.

Reguły stylu kodu są podzielone na następujące podkategorie:

Każda z tych podkategorii definiuje własną składnię określającą opcje. Aby uzyskać więcej informacji o tych regułach i odpowiednich opcjach, zobacz Dokumentacja reguł stylu kodu.

Przykładowy plik EditorConfig

Aby ułatwić rozpoczęcie pracy, oto przykładowy plik editorconfig z opcjami domyślnymi.

Uwaga

Zwięzła składnia widoczna w tym pliku, w której ważność jest określona po wartości opcji reguł języka, na przykład , dotnet_style_readonly_field = true:suggestionjest w pełni zrozumiała dla programu Visual Studio. Kompilatory nie rozumieją sufiksu :<severity-level> i są ignorowane, jeśli skompilujesz kod z wiersza polecenia. Aby ustawić ważność w sposób zrozumiały dla programów Visual Studio i C# i Visual Basic, ustaw ważność reguły zawierającej tę opcję przy użyciu następującej składni:

dotnet_diagnostic.<rule-ID>.severity = <severity-level>

Aby uzyskać więcej informacji, zobacz Format opcji.

Napiwek

  • W programie Visual Studio możesz dodać następujący domyślny plik .editorconfig platformy .NET do projektu w oknie dialogowym Dodawanie nowego elementu . Aby uzyskać szczegółowe instrukcje, zobacz Dodawanie i usuwanie plików EditorConfig.
  • Aby uzyskać informacje na temat używania plików editorconfig w Visual Studio dla komputerów Mac, zobacz Tworzenie i edytowanie niestandardowego pliku EditorConfig.
  • W przypadku programu Visual Studio Code można użyć wtyczki EditorConfig for VS Code, aby zastąpić ustawienia użytkownika/obszaru roboczego ustawieniami znajdującymi się w plikach .editorconfig.
###############################
# 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

Zobacz też