Fragmenty kodu

Fragmenty kodu, często nazywane szablonami kodu, są przydatne do wydajnego programowania, ponieważ umożliwiają wstawianie i edytowanie wstępnie napisanych bloków kodu. Korzystanie z fragmentów kodu może być wygodne do szybkiego dodawania typowych wzorców, a nawet do uczenia się nowych wzorców, gdy jako deweloper nie masz pewności co do składni. Dostępne są szablony dla języka C#, F#, HTML, XML, Python i Razor.

W tej sekcji wyjaśniono, jak tworzyć, wstawiać i używać fragmentów kodu.

Wstawianie fragmentu kodu

Istnieją różne sposoby dodawania fragmentów kodu. Niektóre z nich opisano poniżej:

  • Rozszerzanie karty – Zacznij wpisywać nazwę szablonu, wybierz ją z listy i naciśnij klawisz Tab, aby go dodać:

    Rozszerzanie karty w kodzie

  • Przybornik – Użyj okna przybornika, aby wyświetlić listę wszystkich fragmentów kodu. Przeciągnij dowolny szablon z przybornika do poprawnej pozycji w kodzie źródłowym:

    Fragmenty kodu w przyborniku

  • Polecenie Wstaw szablony – Obecnie nie ma domyślnego zestawu powiązań kluczy na potrzeby wstawiania szablonu. Aby go utworzyć, przejdź do Visual Studio > Preferences > Key Bindings (Preferencje > kluczy i wyszukaj element template . Umożliwia to dodanie odpowiedniego powiązania klucza do pola Edytuj powiązanie, a następnie kliknij przycisk Zastosuj:

    Inset Template , polecenie

Tworzenie nowego szablonu

Istnieje wiele istniejących szablonów w różnych językach, których można używać i edytować, ale nowe szablony można również dodawać, przechodząc do witryny Visual Studio > Preferences > Text Editor (Preferencje >) i > Code Snippets(Fragmenty kodu):

Inset new template (Zestaw nowego szablonu)

Naciśnij przyciski Dodaj lub Edytuj, aby tworzyć lub edytować fragmenty kodu.

Słowa kluczowe we fragmentach kodu

Po wstawieniu fragmentu kodu do edytora wszystkie zdefiniowane słowa kluczowe są wyróżniane i można je edytować za pomocą klawisza Tab między nimi. Słowa kluczowe zachowują się jak "zmienna" we fragmencie kodu i są definiowane przez umieszczenie znaku dolara przed i $ po nazwie słowa kluczowego.

Poniżej przedstawiono okno Edytowanie szablonu, które umożliwia edytowanie wbudowanego prop fragmentu kodu. Fragment kodu zawiera dwa słowa kluczowe, które mogą mieć dodatkowe właściwości ustawione (takie jak wartość domyślna i etykietka narzędzia) po – $type$ prawej stronie $name$ – okna:

Okno Edytowanie szablonu

Następujące pola służą do definiowania fragmentu kodu:

  • Skrót – Tekst, który użytkownik typi, aby wstawić fragment kodu.
  • Grupa – Fragmenty kodu są grupowane w menu zawartości fragmentów kodu przy użyciu tej wartości.
  • Opis – Wyjaśnienie przeznaczenia fragmentu kodu.
  • Mime – Określa typy plików, w których jest dostępny fragment kodu.
  • Szablon z możliwością rozszerzenia – Upewnij się, że to pole jest zaznaczone, aby można było wstawić fragment kodu do kursora, wpisując skrót.
  • Jest otoczony szablonem – Zaznacz tę opcję, aby wyświetlić ten skrót w menu zawartości Otokaj za pomocą... w edytorze.
  • Tekst szablonu – Rzeczywisty fragment kodu, który zostanie wstawiony do edytora. Symbole zastępcze słów kluczowych można zdefiniować, otaczać token znakami dolara, np. $type$.
  • Panel właściwości słowa kluczowego – Po prawej stronie okna użyj listy rozwijanej u góry, aby wybrać słowo kluczowe (np. ) i edytować właściwości, takie jak wartość domyślna i type etykietka narzędzia.

Używanie słów kluczowych w edytorze

Aby użyć fragmentu kodu ze słowami kluczowymi, takimi jak zdefiniowane powyżej, wpisz skrót i naciśnij dwukrotnie klawisz Tab, a zawartość fragmentu kodu zostanie wstawiona do kursora:

Wstawiony fragment kodu przedstawiający słowa kluczowe

Naciśnij klawisz Tab, aby przechodzić między object elementami i MyProperty , aby dostosować fragment kodu dla klasy.

Słowo kluczowe można powtórzyć we fragmencie kodu, na przykład w tym przykładzie, należy zauważyć, że słowo kluczowe for $i$ pojawia się 3 razy:

Szablon fragmentu kodu z powtórzonymi słowami kluczowymi

W przypadku korzystania z edytora klawisz Tab przełącza się między pierwszym i elementem a max . W przypadku nadpisywania zmiennej o innej i nazwie wszystkie trzy wystąpienia zostaną zaktualizowane:

Wstawiony fragment kodu przedstawiający wiele słów kluczowych

Zastrzeżone słowa kluczowe

Istnieją dwa zastrzeżone słowa kluczowe, których można użyć we fragmencie kodu:

  • $selected$Jeśli fragment kodu jest otoczony wybranym szablonem, to słowo kluczowe zostanie zastąpione tekstem wyróżniony w edytorze podczas – wybierania fragmentu kodu.
  • $end$Gdy użytkownik zakończy edytowanie słów kluczowych we fragmencie kodu, kursor zostanie umieszczony – w lokalizacji słowa $end$ kluczowego .

Fragment for kodu w poprzedniej sekcji jest przykładem obu tych zastrzeżonych słów kluczowych.

Zobacz też