Tworzenie i edytowanie niestandardowego pliku EditorConfig w Visual Studio dla komputerów Mac

  • Artykuł

Ważne

Visual Studio dla komputerów Mac ma zostać wycofany 31 sierpnia 2024 r.Nowoczesne zasady cyklu życia. Mimo że możesz nadal pracować z Visual Studio dla komputerów Mac, istnieje kilka innych opcji dla deweloperów na komputerze Mac, takich jak wersja zapoznawcza nowego rozszerzenia zestawu deweloperskiego języka C# dla programu VS Code.

Dowiedz się więcej o osiach czasu pomocy technicznej i alternatywach.

W Visual Studio dla komputerów Mac możesz dodać plik EditorConfig do projektu lub rozwiązania, aby wymusić spójne style kodowania dla wszystkich, którzy pracują w bazie kodu. Ustawienia zadeklarowane w pliku EditorConfig mają pierwszeństwo przed globalnymi ustawieniami edytora tekstów Visual Studio dla komputerów Mac. Użycie pliku EditorConfig w projekcie lub bazie kodu umożliwia ustawienie stylu kodowania, preferencji i ostrzeżeń dla projektu. Ponieważ plik jest częścią bazy kodu, ułatwia wszystkim użytkownikom przestrzeganie praktyk kodowania projektu, niezależnie od używanego środowiska IDE lub edytora kodu.

Pliki EditorConfig są obsługiwane w wielu środowiskach IDE i edytorach kodu, w tym w programie Visual Studio.

Obsługiwane ustawienia

Edytor w Visual Studio dla komputerów Mac obsługuje podstawowy zestaw właściwości EditorConfig:

  • indent_style
  • indent_size
  • tab_width
  • end_of_line
  • charset
  • trim_trailing_whitespace
  • insert_final_newline
  • root

Aplikacja EditorConfig obsługuje również konwencje kodowania w języku C#.

Dodawanie pliku EditorConfig do projektu

Dodawanie nowego pliku EditorConfig

  1. Otwórz projekt w Visual Studio dla komputerów Mac. Wybierz rozwiązanie lub węzeł projektu, do którego chcesz dodać plik EditorConfig. Dodanie pliku do katalogu rozwiązania stosuje ustawienia .editorconfig do wszystkich projektów w rozwiązaniu.

  2. Kliknij prawym przyciskiem myszy węzeł i wybierz polecenie Dodaj nowy plik, aby otworzyć okno dialogowe Nowy plik>:

    Content menu items

  3. Wybierz pozycję Misc Empty Text File (Pusty plik tekstowy) i nadaj mu nazwę.editorconfig.> Naciśnij pozycję Nowy , aby utworzyć plik i otworzyć go w edytorze:

    New file dialog

    Dodanie elementu na poziomie rozwiązania powoduje automatyczne utworzenie i zagnieżdżanie go w folderze Elementy rozwiązania:

    Solution item displayed in Solution Window

  4. Edytuj plik . Na przykład:

    # This file is the top-most EditorConfig file
root = true

# All Files
[*]
indent_style = space
indent_size = 8
insert_final_newline = false
trim_trailing_whitespace = false

[*.cs]
csharp_new_line_before_open_brace = none

  5. Ustawienia z .editorconfig pliku będą stosowane do każdego nowego kodu, który piszesz, ale może być konieczne ponowne sformatowanie istniejącego kodu w celu zapewnienia spójności z nowymi ustawieniami. Aby zastosować ustawienia z .editorconfig pliku do istniejącego pliku źródłowego, otwórz plik i wybierz pozycję Edytuj > format formatu > dokumentu na pasku menu:

    Format Document menu item

Dodawanie istniejącego pliku EditorConfig

Jeśli pracujesz z projektem lub rozwiązaniem, które zawiera .editorconfig już plik, nie ma nic, co należy zrobić, aby zastosować ustawienia. Wszystkie nowe wiersze kodu są formatowane zgodnie z ustawieniami EditorConfig.

Możesz chcieć ponownie użyć istniejącego .editorconfig pliku w projekcie. Aby dodać istniejący plik, wykonaj następujące czynności:

  1. Kliknij prawym przyciskiem myszy folder, do którego chcesz go dodać, i wybierz polecenie Dodaj > pliki.

  2. Przejdź do katalogu wymaganego pliku.

  3. Pliki rozpoczynające się od (takich jak .editorconfig) są ukrytymi plikami . w systemie macOS, więc naciśnij klawisze Command + Shift + . aby plik był .editorconfig widoczny.

  4. .editorconfig Wybierz plik i kliknij pozycję Otwórz:

    adding a new file window

  5. Po wyświetleniu następującego okna dialogowego wybierz opcję Kopiuj plik do katalogu i wybierz przycisk OK:

    Add file to folder dialog options

Emocje ustawień pliku editorconfig

Po dodaniu pliku EditorConfig do bazy kodu wszystkie dodane nowe kod są automatycznie formatowane zgodnie z określonymi ustawieniami. Istniejący kod nie odzwierciedla automatycznie ustawień, chyba że formatujesz bazę kodu.

Aby odzwierciedlić ustawienia z .editorconfig pliku, wybierz węzeł rozwiązania i wybierz pozycję Edytuj > format formatu > dokumentu na pasku menu:

Format document from the menu bar

Edytowanie pliku EditorConfig

Pliki EditorConfig używają prostego układu plików do określania ustawień, które wyjaśniono poniżej, korzystając z poprzedniego przykładu:

# This file is the top-most EditorConfig file
root = true

# All Files
[*]
indent_style = space
indent_size = 4
insert_final_newline = false
trim_trailing_whitespace = false

[*.cs]
csharp_new_line_before_open_brace = none

Ustawienie root flaguje true ten plik jako najbardziej najbardziej plik bazy kodu, a wszystkie wyższe .editorconfig pliki w projekcie są ignorowane, jak wyjaśniono w sekcji Override EditorConfig Ustawienia.

Każda sekcja jest oznaczona nawiasami klamrowymi ([ ]) i określa informacje o typach plików, do których powinny odnosić się następujące właściwości.

W powyższym przykładzie niektóre ustawienia są stosowane do wszystkich plików w projekcie, a inne są dodawane tylko do plików języka C#. Poniższe zrzuty ekranu pokazują przed i po zastosowaniu .editorconfig ustawień:

Przed:

Before editorconfig settings have been applied

Po:

after editorconfig settings have been applied

Aby uzyskać więcej informacji na temat dostępnych ustawień EditorConfig, zobacz artykuł Ustawienia konwencji kodowania platformy .NET dla pliku EditorConfig i sekcja Obsługiwane właściwości w oficjalnej dokumentacji.

Zastąpij Ustawienia EditorConfig

Istnieje możliwość posiadania więcej niż jednego .editorconfig pliku w każdym rozwiązaniu. Visual Studio dla komputerów Mac odczytuje pliki od góry .editorconfig do dołu w rozwiązaniu, dodając i przesłaniając ustawienia w miarę jego instalowania. Oznacza to, że ustawienia znajdujące się najbliżej .editorconfig edytowanych plików będą miały pierwszeństwo. Ustawienia są pobierane z .editorconfig tego samego folderu (jeśli istnieje), a następnie .editorconfig w folderze nadrzędnym (jeśli istnieje) itp. dopóki nie znajdzie root=true.

Jeśli chcesz upewnić się, że żadne ustawienia z plików wyższego poziomu .editorconfig nie są stosowane do tej części bazy kodu, dodaj root=true właściwość na początku pliku niższego poziomu.editorconfig:

# top-most EditorConfig file
root = true

Zobacz też