Udostępnij za pośrednictwem

Dowiedz się więcej o module sprawdzania pisowni

Wiele funkcji w programie Visual Studio zaprojektowano tak, aby ułatwić pisanie żądanego kodu, od upewnienia się, że kod jest kompilowany w celu ułatwienia stylu kodu. Teraz dzięki funkcji sprawdzania pisowni — wprowadzonej w wersji 17.5 — program Visual Studio może nawet upewnić się, że pisownia jest dokładna.

Zrzut ekranu przedstawiający przykład działania sprawdzania pisowni.

Moduł sprawdzania pisowni jest dostępny dla dowolnego pliku C#, C++lub Markdown. Po włączeniu sprawdzania pisowni program Visual Studio oznacza wszystkie wyrazy wykrywane jako błędnie napisane wyrazy. Program Visual Studio sugeruje również alternatywne pisownie i pomaga je poprawić. Funkcja wykonuje nawet kontekstową zmianę nazwy, gdy te błędy pisowni są identyfikatorami, dzięki czemu kod nadal jest kompilowany.

Możesz wyłączyć lub włączyć moduł sprawdzania pisowni za pomocą przycisku Przełącz sprawdzanie pisowni na głównym pasku narzędzi lub wybierając polecenie Edytuj>zaawansowane>sprawdzanie pisowni na pasku menu.

Jak go używać?

Gdy daszek znajduje się na błędzie pisowni, szybkie akcje udostępniają rozwiązania do naprawiania błędów pisowni. Szybkie akcje można wyświetlić za pomocą skrótów klawiaturowych Ctrl+ lub Alt+Enter. Po wyświetleniu menu kontekstowego program Visual Studio wyświetla trzy opcje obsługi problemu z pisownią.

Jeśli którykolwiek z słowników udostępnia sugestie dotyczące pisowni, program Visual Studio wyświetla je. Jeśli wiele słowników udostępnia sugestie, program Visual Studio grupuje sugestie według słownika. W przypadku ciągów i komentarzy wybranie jednej z tych sugestii powoduje zamianę jednego miejsca. W przypadku identyfikatorów w języku C++ lub dokumencie języka C# zaakceptowanie sugestii powoduje refaktoryzację/zmianę nazwy, która aktualizuje wszystkie wystąpienia identyfikatora, aby upewnić się, że kod jest kompilowany.

Zrzut ekranu przedstawiający moduł sprawdzania pisowni z wieloma słownikami wymienionymi.

Możesz również zignorować problem z pisownią. Po wybraniu opcji ignorowania problemu program Visual Studio tworzy plik exclusion.dic w katalogu AppData na komputerze lokalnym. Po wybraniu ignorowania wyrazu narzędzie sprawdzania pisowni ignoruje je we wszystkich wystąpieniach programu Visual Studio.

Jak to działa?

Ponieważ język C#, C++i Markdown używają języka angielskiego jako języka dla ich słów kluczowych, program Visual Studio zwykle używa słownika "Angielski (Stany Zjednoczone)" lub "en-us" na potrzeby sprawdzania pisowni. Program Visual Studio sprawdza wystąpienie systemu Windows pod kątem używanego języka wyświetlania, a jeśli nie jest to "en-us", używa również tego słownika.

Uwaga

Języki C# i C++ mają również dodatkowe słowniki dla słów kluczowych w tych językach, co uniemożliwia oznaczanie wyrazów takich jak "przestrzeń nazw" lub "alloc" jako oznaczone błędnie wyrazami.

Opinie wczesnych użytkowników tej funkcji poinformowały nas, że deweloperzy chcą wiedzieć tylko o błędach w dokumencie, z którymi obecnie pracują. W odpowiedzi na te opinie narzędzie sprawdzania pisowni skanuje tylko dokumenty, które są aktywne w edytorze.

W poniższej tabeli przedstawiono niektóre heurystyki, które narzędzie sprawdzania pisowni sprawdza podczas skanowania dokumentu kodu:

Co znajduje się w kodzie Co sprawdza program Visual Studio Dlaczego?
Hello (Cześć) Witaj, witaj Zawsze sprawdzaj, czy występują zarówno właściwe, jak i typowe rzeczowniki
HelloWorld Witaj, cześć, świat, świat Medial capitals są używane do oznaczania granic słów
Hello.World Witaj, cześć, świat, świat Znak interpunkcyjny jest używany jako granica słowa
_Hello123 Witaj, witaj Liczby wiodące lub końcowe lub znaki interpunkcyjne są usuwane
Hello2World Witaj, cześć, świat, świat Liczby medialne, takie jak znaki interpunkcyjne, są używane jako granica słowa
btnWorld Świat, świat Fragmenty trzech znaków lub mniej są ignorowane
helloworld Helloworld, helloworld Brak wskaźnika identyfikującego granice wyrazów

Jeśli program Visual Studio zidentyfikuje dopasowanie tokenu w dowolnym z używanych słowników, token zostanie uznany za akceptowalny, a skanowanie będzie kontynuowane. W przeciwnym razie token jest uznawany za błędnie napisany, a program Visual Studio flaguje go jako błąd pisowni.

Zrzut ekranu przedstawiający przykład błędów pisowni na liście błędów.

Jak dostosować narzędzie sprawdzania pisowni

Możesz dostosować moduł sprawdzania pisowni, aby był zoptymalizowany pod kątem środowiska współpracy. W związku z tym program Visual Studio używa pliku EditorConfig do konfiguracji, aby można było kontrolować zachowanie modułu sprawdzania pisowni w repozytorium.

Konfigurując plik EditorConfig, można ustanowić standardy kodowania, które mają być zgodne ze wszystkimi, co pozwala zachować spójność kodowania, która może być trudna w przypadku innych metod.

Ważne

Opcje błędów pisowni są specyficzne dla pliku. Należy określić, do których plików są stosowane opcje pisowni. W poniższym przykładzie opcje pisowni są stosowane do wszystkich plików języka C# w rozwiązaniu:

[*.cs]

Poniżej przedstawiono kilka przykładów i scenariuszy przypadków użycia przełączników, które można skonfigurować w pliku EditorConfig:

  • Wyświetl listę języków używanych przez program Visual Studio. W tym przykładzie program Visual Studio używa tylko słowników "en-us" i "fr-fr" podczas sprawdzania pod kątem problemów z pisownią.

    spelling_languages = _language_[,_language_]
    (Example: = en-us,fr-fr)

    Uwaga

    Pamiętaj, aby zainstalować pakiet językowy dla dowolnego języka, którego używasz, aby uniemożliwić programowi Visual Studio niepoprawne oznaczanie wyrazów jako błędów pisowni.

  • Określ, co program Visual Studio powinien sprawdzić. W tym przykładzie program Visual Studio sprawdza identyfikatory i komentarze pod kątem błędnie napisanych wyrazów, ale nie sprawdza się wewnątrz ciągów.

    spelling_checkable_types = strings,identifiers,comments
    (Example: = identifiers,comments)

  • Kontroluj ważność przypisywania programu Visual Studio do błędów pisowni na liście błędów. W tym przykładzie błędy pisowni są wyświetlane jako błędy.

    spelling_error_severity = error OR warning OR information OR hint
    (Example: = error)

  • Utwórz własny słownik wykluczeń, aby określić wyrazy, które należy wziąć pod uwagę jako poprawne pisownia. W tym przykładzie po raz pierwszy narzędzie sprawdzania pisowni jest uruchamiane względem dowolnego pliku w rozwiązaniu, program Visual Studio sprawdza plik exclusion.dic. Program Visual Studio sprawdza ten sam katalog pliku .sln dla projektu języka C# lub w katalogu głównym katalogu C++. Jeśli plik exclusion.dic nie istnieje, program Visual Studio go utworzy. Następnie za każdym razem, gdy użytkownik wybierze zignorowanie wyrazu, program Visual Studio doda go do tego pliku exclusion.dic. Program Visual Studio traktuje dowolne słowo, które pojawia się w tym pliku exclusion.dic jako poprawnie napisane słowo.

    spelling_exclusion_path = absolute OR relative path to exclusion dictionary
    (Example: = .\exclusion.dic)

    Uwaga

    Program Visual Studio używa słownika wykluczeń określonego spelling_exclusion_path przez przełącznik w pliku .editorconfig lub pliku exclusion.dic w %localappdata%\Microsoft\VisualStudio\<Version> katalogu, jeśli nie można odnaleźć przełącznika.

  • Określ, czy jest używany domyślny słownik wykluczeń specyficzny dla języka. Ta flaga jest domyślnie ustawiona na true. Wszystkie wyrazy dodane do słownika wykluczeń specyficznego dla języka będą traktowane jako poprawne pisownia. Ustaw wartość false, aby zignorować słowniki wykluczeń specyficzne dla języka C++ lub C#.

    spelling_use_default_exclusion_dictionary = true OR false
    (Example: = spelling_use_default_exclusion_dictionary = false)

Oto kompletny przykład:

[*.{cs,vb}]                                         //specify which files the spelling options apply to
spelling_languages = en-us,fr-fr                    //specifies the en-us and fr-fr dictionaries for use in spell checking
spelling_checkable_types = identifiers,comments     //specifies that identifiers and comments are the only checked elements
spelling_error_severity = error                     //sets severity assigned to spelling errors to error in the error list
spelling_exclusion_path = exclusion.dic             //defines a custom exclusion dictionary location and file
spelling_use_default_exclusion_dictionary = false   //ignores the language-specific default exclusion dictionary

Obsługa przypadków specjalnych

Program Visual Studio ma pewne unikatowe zachowania podczas sprawdzania kodu pod kątem błędów pisowni, które różnią się od tradycyjnych modułów sprawdzania pisowni przeznaczonych dla tekstu pisanego. Niektóre z tych zachowań obejmują:

  • W ciągu zawierającym znaki interpunkcyjne, na przykład "misc." program Visual Studio nie zaproponuje poprawki, ponieważ interpunkcja w identyfikatorze może spowodować, że kod nie zostanie skompilowany.
  • Ukośniki odwrotne w ciągu spowodują pominięcie kolejnego znaku podczas sprawdzania pisowni i traktowania ukośnika odwrotnego i późniejszego znaku jako ogranicznika wyrazu. Na przykład w ciągu hello\nworldprogram Visual Studio najpierw wykrywa ukośnik odwrotny. Program Visual Studio traktuje \n jako ogranicznik wyrazów, który pozostawia "hello" i "world", z których każdy jest sprawdzany indywidualnie.
  • Ciągi zawierające adresy URL, takie jak https://... lub mailto:.. nie będą sprawdzane pisownią w całym ciągu.

Powiązana zawartość