Preferencje stylu kodu

Ustawienia stylu kodu dla projektu można zdefiniować przy użyciu pliku EditorConfiglub dla całego kodu edytowanego w programie Visual Studio w edytorze tekstów Opcje strony. W przypadku kodu w języku C# można również skonfigurować program Visual Studio, aby zastosować te preferencje stylu kodu przy użyciu komend Code Cleanup (Visual Studio 2019, Visual Studio 2022) i Formatuj dokument (Visual Studio 2017).

Style kodu w plikach EditorConfig

ustawienia stylu kodu dla platformy .NET można określić, dodając plik EditorConfig do projektu. Pliki EditorConfig są skojarzone z bazą kodu, a nie kontem personalizacji programu Visual Studio. Ustawienia w pliku EditorConfig mają pierwszeństwo przed stylami kodu określonymi w oknie dialogowym Opcje. Użyj pliku EditorConfig, jeśli chcesz wymusić style kodowania dla wszystkich współautorów w repozytorium lub projekcie.

Możesz ręcznie wypełnić plik EditorConfig lub automatycznie wygenerować plik na podstawie ustawień stylu kodu wybranych w oknie dialogowym Opcje programu Visual Studio. Ta strona opcji jest dostępna w Tools>Options>Text Editor> [C# lub Visual Basic] >Code Style>General. Kliknij Wygeneruj plik editorconfig z ustawień, aby automatycznie wygenerować styl kodowania pliku .editorconfig na podstawie ustawień na tej stronie Opcje.

Style kodu w oknie dialogowym Opcje

Preferencje stylu kodu można ustawić dla wszystkich projektów języka C# i Visual Basic, otwierając okno dialogowe Opcje z Menu Narzędzia . W oknie dialogowym Opcje wybierz Edytor tekstu > [C# lub język Visual Basic ] >Styl kodu>Ogólne.

Po wybraniu każdego elementu na liście jest wyświetlany podgląd preferencji:

Opcje ustawione w tym oknie mają zastosowanie do konta personalizacji programu Visual Studio i nie są skojarzone z konkretnym projektem ani bazą kodu. Ponadto nie są wymuszane w czasie kompilacji, w tym w kompilacjach ciągłej integracji. Jeśli chcesz skojarzyć preferencje stylu kodu z projektem i wymusić style podczas kompilacji, określ preferencje w pliku .editorconfig skojarzone z projektem.

Preferencje i dotkliwość

Dla każdego ustawienia stylu kodu na tej stronie można ustawić wartości preferencji i ważności przy użyciu rozwijanych list w każdym wierszu. Ważność można ustawić jako Tylko refaktoryzacja, Sugestia, Ostrzeżenie, lub Błąd. Jeśli chcesz włączyć szybkie akcje stylu kodu, upewnij się, że ustawienie ważność jest ustawione na inną wartość niż Refaktoryzacja tylko. Ikona Quick Actions żarówki , ikona żarówki błędu lub ikona śrubokręta jest wyświetlana, gdy jest używany styl inny niż preferowany, i można wybrać opcję z listy Quick Actions, aby automatycznie przepisać kod do preferowanego stylu.

Wymuszanie stylów kodu na kompilacji

Począwszy od programu Visual Studio 2019 w wersji 16.8, która zawiera zestaw .NET 5.0 RC2 SDK, można wymusić konwencje kodowania platformy .NET na kompilacji dla wszystkich projektów platformy .NET. W czasie kompilacji naruszenia stylu kodu platformy .NET będą wyświetlane jako ostrzeżenia lub błędy z prefiksem "IDE". Umożliwia to ścisłe wymuszanie spójnych stylów kodu w bazie kodu.

Stosowanie stylów kodu

W przypadku plików kodu w języku C# program Visual Studio ma przycisk Czyszczenie kodu w dolnej części edytora (klawiatura: Ctrl+K, Ctrl+E) do zastosowania stylów kodu z pliku EditorConfig lub ze strony opcji Styl kodu. Jeśli plik .editorconfig istnieje dla projektu, są to ustawienia, które mają pierwszeństwo.

Wskazówka

Reguły skonfigurowane z priorytetem Brak nie uczestniczą w uporządkowaniu kodu, ale można je stosować indywidualnie za pomocą menu Szybkie akcje i refaktoryzacje.

Oto jak zastosować style kodu:

1. Najpierw skonfiguruj style kodu, które chcesz zastosować (w jednym z dwóch profilów) w oknie dialogowym Konfigurowanie oczyszczania kodu. Aby otworzyć to okno dialogowe, kliknij strzałkę rozwijania obok ikony miotła oczyszczania kodu, a następnie wybierz Skonfiguruj oczyszczanie kodu.

   

2. Po skonfigurowaniu oczyszczania kodu użyj jednej z następujących metod, aby uruchomić oczyszczanie kodu:

   • Kliknij ikonę miotły lub naciśnij Ctrl+K, Ctrl+E.

     

   • Aby uruchomić oczyszczanie kodu w całym projekcie lub rozwiązaniu, kliknij prawym przyciskiem myszy nazwę projektu lub rozwiązania w eksploratorze rozwiązań , wybierz pozycję Analizuj i oczyszczanie kodu, a następnie wybierz uruchom oczyszczanie kodu.

     

   Jeśli chcesz, aby ustawienia stylu kodu były stosowane za każdym razem, gdy zapisujesz plik, przejdź do Opcje>Edytor tekstu>Sprzątanie kodu i wybierz Uruchom profil sprzątania kodu przy zapisie.

Ustawienia oczyszczania kodu

Większość ustawień oczyszczania kodu jest mapowana do jednego lub więcej stylów kodu .NET obsługiwanych w .editorconfig. W przypadku przykładów pokazujących efekty ustawień użyj linków w poniższej tabeli.

Ustawienie	Identyfikator reguły lub opcja stylu
Usuwanie niepotrzebnych importów lub użycia	IDE0005
Sortowanie importu lub użycia	Posortuj dyrektywy systemowe dotnet jako pierwsze Oddziel grupy dyrektyw importu dotnet
Stosowanie preferencji nagłówka pliku	file_header_template
Usuwanie nieużywanych zmiennych	CS0219
Stosowanie preferencji tworzenia obiektów	visual_basic_style_prefer_simplified_object_creation
Zastosuj preferencje IsNot	visual_basic_style_prefer_isnot_expression
Dodaj określenie „this” lub „Me”	IDE0003-IDE0009
Dodawanie modyfikatorów ułatwień dostępu	dotnet_style_require_accessibility_modifiers
Modyfikatory kolejności	IDE0036
Ustaw pole jako tylko do odczytu	dotnet_style_readonly_field
Usuń niepotrzebne rzutowania	IDE0004
Stosowanie parametrów inicjowania obiektu/kolekcji)	dotnet_style_object_initializer
Zastosowanie preferencji dotyczących umiejscowienia dyrektyw	csharp_using_directive_placement
Stosowanie preferencji nawiasów	IDE0047-IDE0048
Stosowanie nieużywanych preferencji wartości	IDE0058
Stosowanie preferencji typu języka/struktury	IDE0049
Usuń nieużywane tłumienia	dotnet_remove_unnecessary_suppression_exclusions
Zastosuj preferencje upraszczania wyrażeń logicznych	dotnet_style_prefer_simplified_boolean_expressions
Stosowanie preferencji interpolacji ciągów	dotnet_style_prefer_simplified_interpolation
Usuwanie nieużywanych parametrów	dotnet_code_quality_unused_parameters
Zastosuj preferencje automatycznych właściwości	dotnet_style_prefer_auto_properties
Stosowanie preferencji przypisania złożonego	dotnet_style_prefer_compound_assignment
Stosowanie preferencji wyrażeń złączeniowych	dotnet_style_coalesce_expression
Stosowanie preferencji wyrażeń warunkowych	dotnet_style_prefer_conditional_expression_over_assignment dotnet_style_prefer_conditional_expression_over_return
Zastosuj preferencje nazw krotek	dotnet_style_explicit_tuple_names dotnet_style_prefer_inferred_tuple_names
Stosowanie wywnioskowanych preferencji nazw członków typu anonimowego	dotnet_style_prefer_inferred_anonymous_type_member_names
Stosowanie preferencji sprawdzania wartości null	dotnet_style_prefer_is_null_check_over_reference_equality_method
Zastosuj preferencje propagacji wartości null	dotnet_style_null_propagation
Stosowanie preferencji "var"	IDE0007-IDE0008
Dodaj wymagane nawiasy klamrowe dla jednowierszowych instrukcji sterujących	csharp_prefer_braces
Stosowanie preferencji dla wyrażeń/ciał bloków	członkowie z wyrażeniem ciała
Stosowanie wbudowanych preferencji zmiennych "out"	csharp_style_inlined_variable_declaration
Stosowanie preferencji dopasowywania wzorca	preferencje dopasowywania wzorców
Stosuj preferencje dla warunkowych wywołań delegatów	csharp_style_conditional_delegate_call
Stosowanie preferencji statycznych funkcji lokalnych	csharp_prefer_static_local_function
Stosowanie dekonstrukcyjnych preferencji	csharp_style_deconstructed_variable_declaration
Zastosuj preferencje domyślne (T)	csharp_prefer_simple_default_expression
Zastosowanie preferencji new()	csharp_style_implicit_object_creation_when_type_is_apparent
Stosowanie preferencji zakresu	csharp_style_prefer_range_operator
Zastosuj lokalne preferencje zamiast preferencji funkcji anonimowych	csharp_style_pattern_local_over_anonymous_function
Stosowanie preferencji parametru o wartości null	preferencje sprawdzania wartości null
Zastosowanie preferencji poleceń	csharp_prefer_simple_using_statement
Stosowanie preferencji wyrażenia throw	csharp_style_throw_expression

::: moniker-end

Powiązana zawartość

• szybkie akcje
• Ustawienia konwencji kodowania .NET dla pliku EditorConfig