Fragmenty kodu i sposób ich używania

Fragmenty kodu to małe bloki kodu wielokrotnego użytku, które można dodać do pliku kodu. Fragmenty kodu zwykle zawierają często używane bloki kodu, takie jak Try...Finally lub If...Else bloki. Możesz również użyć fragmentów kodu, aby dodać całe klasy lub metody.

Fragment kodu ma tytuł używany do wybierania fragmentu kodu i może mieć nazwę skrótu, którą można wpisać, aby wstawić fragment kodu. Fragmenty kodu mogą również zawierać parametry zastępcze, które działają jako symbole zastępcze. Fragmenty kodu są dostępne dla wielu języków, w tym C#, C++i Visual Basic.

Fragmenty kodu rozszerzenia i fragmenty kodu otaczają się fragmentami kodu

Do kodu można dodać dwa rodzaje fragmentów kodu:

  • Fragment kodu rozszerzenia jest dodawany w określonym punkcie wstawiania.
  • Element otoczony fragmentem kodu jest dodawany wokół wybranego kodu i jest dostępny tylko dla języków C# i C++.

Znajdowanie dostępnych fragmentów kodu

Aby wyświetlić dostępne fragmenty kodu dla języka, wybierz pozycję Narzędzia>Menedżer fragmentów kodu na pasku menu lub naciśnij klawisze Ctrl+K, B, a następnie wybierz odpowiedni język z menu rozwijanego.

Zrzut ekranu przedstawiający okno dialogowe Menedżer fragmentów kodu.

Aby utworzyć i zaimportować własny fragment kodu, aby był wyświetlany na liście fragmentów kodu, zobacz Przewodnik: tworzenie fragmentu kodu w programie Visual Studio.

Dodawanie fragmentu kodu do pliku kodu

Aby dodać fragment kodu do pliku kodu:

  1. W edytorze kodu umieść kursor lub wybierz kod C# lub C++, w którym chcesz dodać fragment kodu.

  2. Przeprowadź jedną z następujących czynności:

    • Na pasku menu programu Visual Studio wybierz pozycję Edytuj>wstaw wstaw fragment kodu funkcji IntelliSense>lub Edytuj>funkcję IntelliSense>Otocz za pomocą.
    • Kliknij prawym przyciskiem myszy i z menu kontekstowego wybierz pozycję >Wstaw wstaw wstaw fragment kodu lub> Fragment fragmentu kodu otocz z menu kontekstowego.
    • Na klawiaturze naciśnij klawisze Ctrl+K, X, aby uzyskać fragment kodu rozszerzenia lub Ctrl+K, S, aby ująć fragment kodu otoki.
  3. Kliknij dwukrotnie odpowiedni fragment kodu na liście rozwijanej lub wpisz skrót fragmentu kodu i naciśnij klawisz Tab lub Enter.

Dodawanie fragmentu kodu rozszerzenia

Na przykład fragment kodu tryf rozszerzenia języka C# dodaje następujący Try...Finally blok:

try
{

}
finally
{

}

Aby dodać ten fragment kodu rozszerzenia:

  1. W edytorze kodu umieść kursor, w którym chcesz dodać fragment kodu.
  2. Kliknij prawym przyciskiem myszy i wybierz polecenie Wstaw fragment kodu z menu kontekstowego prawym przyciskiem myszy lub użyj paska menu lub poleceń klawiatury.
  3. Otwórz folder Visual C#, a następnie kliknij dwukrotnie tryfna liście rozwijanej lub wybierz tryfi naciśnij klawisz Tab lub Enter.

Napiwek

Możesz również umieścić kursor w punkcie wstawiania, wpisać tryf, a następnie dwukrotnie nacisnąć klawisz Tab .

Dodawanie fragmentu kodu surround-with

W poniższym przykładzie fragmentu kodu języka C++ skrót if może służyć jako fragment kodu wstawiania lub fragmentu kodu otaczającego. Jeśli wybierzesz wiersz return FALSE; kodu, a następnie wybierz pozycję Otocz>z, jeśli fragment kodu zostanie rozszerzony wokół wiersza.

if (true)
{
    return FALSE;
}

Parametry zastępcze fragmentu kodu

Fragmenty kodu mogą zawierać parametry zastępcze, które są symbolami zastępczymi, które należy zastąpić, aby dopasować kod, który piszesz. W poprzednim przykładzie true jest parametrem zastępczym, który zastępuje się odpowiednim warunkiem. Zamiana jest powtarzana dla każdego wystąpienia tego parametru zastępczego we fragmencie kodu.

Na przykład w języku Visual Basic znajduje się fragment kodu, który definiuje właściwość. Aby wstawić fragment kodu:

  1. W menu kontekstowym prawym przyciskiem myszy w pliku kodu języka Visual Basic wybierz pozycję Wstaw fragment>kodu.
  2. Wybierz pozycję Właściwości wzorców kodu>, procedury, zdarzenia>definiują właściwość.

Zrzut ekranu przedstawiający menu fragmentu kodu dla opcji Zdefiniuj właściwość.

Wstawiany jest następujący kod:

Private newPropertyValue As String
Public Property NewProperty() As String
    Get
        Return newPropertyValue
    End Get
    Set(ByVal value As String)
        newPropertyValue = value
    End Set
End Property

Jeśli zmienisz wartość newPropertyValue na m_property, każde wystąpienie newPropertyValue zmian. Jeśli zmienisz String wartość na Int w deklaracji właściwości, wartość w metodzie Set również zmieni się na Int.

Najlepsze rozwiązania dotyczące używania fragmentów kodu

Kod we fragmencie kodu pokazuje tylko najbardziej podstawowy sposób na zrobienie czegoś. W przypadku większości aplikacji kod musi zostać zmodyfikowany tak, aby był zgodny z aplikacją.

Obsługa wyjątków

Zazwyczaj fragment Try...Catch kodu blokuje przechwytywanie i ponowne tworzenie wszystkich wyjątków, ale może to nie być właściwy wybór dla projektu. Dla każdego wyjątku istnieje kilka sposobów reagowania. Przykłady można znaleźć w temacie How to handle an exception using try/catch (C#) and Try... Złapać... Finally — instrukcja (Visual Basic).

Lokalizacje plików

Podczas dostosowywania lokalizacji plików do aplikacji należy wziąć pod uwagę następujące czynniki.

  • Znajdź dostępną lokalizację. Użytkownicy mogą nie mieć dostępu do folderu Program Files komputera, więc przechowywanie plików użytkownika z plikami aplikacji może nie działać.

  • Znajdź bezpieczną lokalizację. Przechowywanie plików w folderze głównym, takich jak C:\ , nie jest bezpieczne. W przypadku danych aplikacji najlepiej użyć folderu Dane aplikacji. W przypadku danych poszczególnych użytkowników aplikacja może utworzyć plik w folderze Dokumenty każdego użytkownika.

  • Użyj prawidłowej nazwy pliku. Za pomocą OpenFileDialog kontrolek i SaveFileDialog można zmniejszyć prawdopodobieństwo wystąpienia nieprawidłowych nazw plików.

  • Należy pamiętać, że plik wybrany przez użytkownika może zostać usunięty, zanim kod będzie mógł manipulować plikiem. Ponadto użytkownik może nie mieć uprawnień do zapisu w pliku.

Zabezpieczenia

Bezpieczeństwo fragmentu kodu zależy od tego, gdzie jest on używany w kodzie źródłowym i jak go modyfikować po jego utworzeniu w kodzie. Poniższa lista zawiera kilka obszarów, które należy wziąć pod uwagę:

  • Dostęp do plików i bazy danych
  • Zabezpieczenia dostępu kodu
  • Ochrona zasobów, takich jak dzienniki zdarzeń i rejestr
  • Przechowywanie wpisów tajnych
  • Weryfikowanie danych wejściowych
  • Przekazywanie danych do technologii skryptów

Aby uzyskać więcej informacji, zobacz Zabezpieczanie aplikacji.

Pobrane fragmenty kodu

Fragmenty kodu zainstalowane przez program Visual Studio nie są samymi zagrożeniami bezpieczeństwa. Mogą jednak tworzyć zagrożenia bezpieczeństwa w aplikacji. Fragmenty kodu pobrane z Internetu powinny być traktowane z ekstremalną ostrożnością, podobnie jak każda inna pobrana zawartość. Pobierz fragmenty kodu tylko z zaufanych witryn i korzystaj z aktualnego oprogramowania antywirusowego.

Otwórz wszystkie pobrane pliki fragmentu kodu w Notatnik lub edytorze XML programu Visual Studio i przejrzyj je dokładnie przed zainstalowaniem. Należy pamiętać o następujących problemach:

  • Kod fragmentu kodu, który może uszkodzić system w przypadku jego wykonania. Dokładnie przeczytaj kod źródłowy przed jego uruchomieniem.

  • HelpURL bloki w plikach fragmentów kodu zawierających adresy URL, które wykonują złośliwe pliki skryptów lub wyświetlają obraźliwe witryny internetowe.

  • Fragmenty kodu zawierające odwołania dodawane w trybie dyskretnym do projektu i mogą być ładowane z dowolnego miejsca w systemie. Możesz pobrać te odwołania z tej samej lokalizacji, z której pobrasz fragment kodu. Fragment kodu może następnie wywołać metodę w odwołaniu, która wykonuje złośliwy kod. Aby wykryć takie odwołania, przejrzyj Imports bloki i References pliku fragmentu kodu.