코드 스타일 규칙 옵션

  • 아티클

구성 파일에서 .NET 코드 스타일 규칙 및 관련 옵션을 정의하여 코드베이스에서 일관된 코드 스타일을 정의하고 유지할 수 있습니다. 이러한 규칙은 코드를 편집할 때 Visual Studio와 같은 다양한 개발 IDE에 의해 표시됩니다. .NET 프로젝트의 경우 이러한 규칙을 빌드 시간에 적용할 수도 있습니다. 개별 규칙을 사용하거나 사용하지 않도록 설정하고 심각도 수준을 통해 각 규칙을 적용하려는 수준을 구성할 수 있습니다.

팁

  • EditorConfig 파일에서 코딩 규칙을 정의하는 경우, 코드 스타일 분석기가 코드를 분석하는 방법을 구성하는 것입니다. EditorConfig 파일은 이러한 분석기의 구성 파일입니다.

  • 코드 스타일 옵션은 Visual Studio의 텍스트 편집기 옵션 대화 상자에서 설정할 수도 있습니다. 이러한 옵션은 Visual Studio에서 편집하는 동안에만 적용되는 사용자별 옵션입니다. 이러한 옵션은 빌드 시간에 또는 다른 IDE에서 적용되지 않습니다. 또한 Visual Studio 내에서 열린 프로젝트 또는 솔루션에 EditorConfig 파일이 있는 경우 이 EditorConfig 파일의 옵션이 우선적으로 적용됩니다. Windows의 Visual Studio에서 텍스트 편집기 옵션을 사용하여 EditorConfig 파일을 생성할 수도 있습니다. 도구>옵션>텍스트 편집기>[C# 또는 Basic] >코드 스타일>일반을 선택한 다음 설정에서 .editorconfig 파일 생성을 클릭합니다. 자세한 내용은 코드 스타일 기본 설정을 참조하세요.

코드 스타일 규칙은 다음 하위 범주로 나뉩니다.

이러한 하위 범주는 각각 옵션 지정을 위한 자체 구문을 정의합니다. 이러한 규칙 및 해당 옵션에 대한 자세한 내용은 코드 스타일 규칙 참조를 참조하세요.

예제 EditorConfig 파일

다음은 시작하는 데 도움이 되는 기본 옵션의 예제 .editorconfig 파일입니다.

참고 항목

이 파일에 표시되는 간결한 구문입니다. 여기서 심각도는 언어 규칙의 옵션 값(예: dotnet_style_readonly_field = true:suggestion)을 Visual Studio에서 완전히 인식한 후에만 지정됩니다. 컴파일러는 :<severity-level> 접미사를 인식하지 못하며 명령줄에서 코드를 컴파일하면 무시됩니다. Visual Studio와 C# 및 Visual Basic 컴파일러에서 인식하는 방식으로 심각도를 설정하려면 다음 구문을 사용하여 옵션이 포함된 규칙의 심각도를 설정합니다.

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

자세한 내용은 옵션 형식을 참조하세요.

팁

###############################
# 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

참고 항목