Verwenden von Codeausschnitten in Visual Studio

Codeausschnitte sind kleine Blöcke wiederverwendbarer Code, die Sie einer Codedatei hinzufügen können. Codeausschnitte enthalten in der Regel häufig verwendete Konstrukte wie Try...Finally oder If...Else Blöcke. Sie können auch Codeausschnitte verwenden, um ganze Klassen oder Methoden hinzuzufügen.

Ein Codeausschnitt hat einen Titel, mit dem Sie ihn auswählen, und kann einen Kurzbefehl haben, den Sie eingeben, um ihn einzufügen. Codeausschnitte können auch Ersetzungsparameter enthalten, die als Platzhalter fungieren. Visual Studio stellt Codeausschnitte für viele Sprachen bereit, einschließlich C#, C++ und Visual Basic.

Voraussetzungen

  • Visual Studio mit installierter Unterstützung für die programmiersprache, die Sie verwenden möchten. Die verfügbaren Codeausschnitte hängen von den installierten Workloads und Sprachkomponenten ab.
  • Eine Codedatei wird im Editor geöffnet und vom entsprechenden Sprachdienst erkannt. Öffnen Sie für das C++-Beispiel eine Datei vom Typ .h oder .cpp.

Grundlegendes zu Codeausschnitttypen

Visual Studio unterstützt zwei Arten von Codeausschnitten:

  • Ein Erweiterungssnippet fügt an einem angegebenen Einfügepunkt Code hinzu.
  • Ein Umgebungs-Codeausschnitt fügt Code um den ausgewählten Code herum ein. Surround-With-Codeausschnitte sind nur für C# und C++ verfügbar.

Suchen nach verfügbaren Codeausschnitten

Um die installierten Codeausschnitte für eine Sprache anzuzeigen, wählen Sie denCodeausschnitt-Manager für Tools> aus, oder drücken Sie STRG+K, STRG+B. Wählen Sie im Codeausschnitt-Manager eine Sprache aus der Liste "Sprache " aus.

Informationen zum Erstellen und Importieren ihres eigenen Codeausschnitts, damit er in der Codeausschnittliste angezeigt wird, finden Sie unter Walkthrough: Create a code snippet in Visual Studio.

Note

Tastenkombinationen können je nach Einstellungsprofil, Kontext, Tastaturlayout und benutzerdefinierten Tastenbindungen variieren. Informationen zum Suchen der Bindung für einen Befehl finden Sie unter Identifizieren und Anpassen von Tastenkombinationen.

Einfügen eines Erweiterungsausschnitts

Ein Erweiterungsausschnitt fügt Code an der Einfügemarke ein. Der C# tryf -Codeausschnitt fügt beispielsweise einen try/finally Block hinzu:

try
{

}
finally
{

}

Sie müssen den tryf Codeausschnitt einfügen, in dem eine Anweisung gültig ist, z. B. innerhalb einer Methode, eines Indexers, eines Eigenschaftenaccessors oder eines Ereignisaccessors.

  1. Positionieren Sie im Code-Editor den Cursor an der Stelle, an der Sie den Codeausschnitt hinzufügen möchten.

  2. Führen Sie eine der folgenden Aktionen aus:

    • Wählen Sie in der Menüleiste Bearbeiten>IntelliSense> aus.
    • Klicken Sie mit der rechten Maustaste, und wählen Sie"Codeausschnitt einfügen"> aus.
    • Drücken Sie STRG+K, STRG+X.

  3. Öffnen Sie in der Codeausschnittauswahl den Visual C# -Ordner, und doppelklicken Sie dann auf tryf. Sie können auch tryf auswählen und die TAB - oder EINGABETASTE drücken.

Der try/finally Block erscheint an der Einfügemarke und kann nun angepasst werden.

Tipp

Geben Sie an einer gültigen Einfügeposition tryf ein, und drücken Sie dann zweimal die Tab-Taste, um den Codeausschnitt zu erweitern, ohne die Codeausschnittauswahl zu öffnen.

Ausgewählten Code mit einem Codeausschnitt umgeben

Ein Surround-With-Snippet umschließt den markierten Code. Beispielsweise umschließt der C++ if -Codeausschnitt die ausgewählte Zeile return FALSE; in einem if Block:

if (true)
{
    return FALSE;
}

So umgeben Sie den ausgewählten C++-Code:

  1. Wählen Sie in einer .cpp- oder .h-Datei den Code aus, den Sie umschließen möchten.

  2. Führen Sie eine der folgenden Aktionen aus:

    • Wählen Sie auf der Menüleiste Bearbeiten>IntelliSense> aus.
    • Klicken Sie mit der rechten Maustaste, und wählen Sie "Umgeben mit" aus.

  3. Doppelklicken Sie in der Codeausschnitt-Auswahl auf if, oder wählen Sie if aus und drücken Sie Tab oder Eingabetaste.

Der if Block wird um den ausgewählten Code herum angezeigt. Ersetzen Sie den true Platzhalter durch die Bedingung, die Sie auswerten möchten.

Weitere C ++-Codeausschnittbeispiele finden Sie unter Visual C++-Codeausschnitte.

Bearbeiten von Ersetzungsfeldern

Codeausschnitte können Ersatzfelder enthalten, die Sie nach dem Einfügen anpassen. Wenn dasselbe Feld mehrmals angezeigt wird, ändert das Ändern eines Vorkommens alle verknüpften Vorkommen. Drücken Sie die TAB-TASTE , um zum nächsten Ersetzungsfeld zu wechseln.

Beispielsweise enthält der Visual Basic-Codeausschnitt Define a Property verknüpfte Felder für die zugrunde liegende Variable, den Eigenschaftsnamen und den Eigenschaftstyp. So fügen Sie sie ein:

  1. Klicken Sie in einer Visual Basic Codedatei mit der rechten Maustaste auf die Stelle, an der Sie die Eigenschaft einfügen möchten, und wählen Sie dannCodeausschnitt einfügen aus>.
  2. Wählen Sie Codemustereigenschaften>, Prozeduren, Ereignisse>definieren eine Eigenschaft aus.

Screenshot der Visual Basic-Codeausschnitt-Auswahl, wobei unter Eigenschaften, Prozeduren und Ereignisse die Option „Eigenschaft definieren“ ausgewählt ist.

Der folgende Code wird eingefügt:

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

Wenn Sie m_property in newPropertyValue ändern, wird jede verknüpfte Instanz von newPropertyValue geändert. Wenn Sie den Eigenschaftstyp von String in Integer ändern, werden alle verknüpften Instanzen von String in Integer geändert.

Fehlerbehebung für Codeausschnitte

Wenn ein Codeausschnitt oder Befehl nicht verfügbar ist:

  • Vergewissern Sie sich, dass Visual Studio die Datei als erwartete Programmiersprache erkennt.
  • Vergewissern Sie sich, dass die erforderliche Workload- oder Sprachkomponente installiert ist.
  • Vergewissern Sie sich imCodeausschnitt-Managervon Tools>, dass der Codeausschnitt für die ausgewählte Sprache installiert ist.
  • Wenn eine Tastenkombination nicht wie erwartet funktioniert, verwenden Sie die Tastenkombinationen identifizieren und anpassen , um die aktuelle Bindung des Befehls nachzuschlagen.
  • Überprüfen Sie, ob die Einfügemarke für den ausgewählten Codeausschnitt gültig ist. Beispielsweise sind einige C#-Codeausschnitte nur innerhalb einer Methode oder Typdeklaration gültig. Gültige C#-Einfügepositionen finden Sie unter C#-Codeausschnitte.

Durch Snippets eingefügten Code überprüfen

Codeausschnitt zeigt eine einfache Möglichkeit zum Ausführen einer Aufgabe. Überprüfen und anpassen Sie den generierten Code, bevor Sie ihn in einer Anwendung verwenden. Überlegen Sie, wie der Code Ausnahmen verarbeitet, auf Ressourcen zugreift, Eingaben überprüft und geheime Schlüssel schützt.

Behandeln Sie Codeausschnitte, die aus dem Internet heruntergeladen wurden, wie andere heruntergeladene Code. Laden Sie Codeausschnitte nur aus Quellen herunter, denen Sie vertrauen, und überprüfen Sie den Codeausschnitt und die Metadaten, bevor Sie ihn importieren oder ausführen.

In .NET Framework-Projekten kann ein Codeausschnitt das References Element verwenden, um Projektverweise hinzuzufügen. Überprüfen Sie die Elemente Imports und References und vergewissern Sie sich, dass Sie den referenzierten Assemblys vertrauen. Weitere Informationen finden Sie unter Importieren eines Namespaces und der Codeausschnittschemareferenz.

Siehe auch

  • Last updated on