Freigeben über

Codeausschnitte und deren Verwendung

Codeausschnitte sind kleine Blöcke wiederverwendbarer Code, die Sie einer Codedatei hinzufügen können. Codeausschnitte enthalten in der Regel häufig verwendete Codeblöcke 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, den Sie zum Auswählen des Codeausschnitts verwenden, und kann einen Verknüpfungsnamen haben, den Sie eingeben können, um den Codeausschnitt einzufügen. Codeausschnitte können auch Ersetzungsparameter enthalten, die als Platzhalter fungieren. Codeausschnitte sind für viele Sprachen verfügbar, einschließlich C#, C++ und Visual Basic.

Erweiterungsausschnitte und Umgebungs-Codeausschnitte

Sie können Ihrem Code zwei Arten von Codeausschnitten hinzufügen:

  • An einer angegebenen Einfügepunkt wird ein Erweiterungsausschnitt hinzugefügt.
  • Ein Surround-With-Codeausschnitt wird um den ausgewählten Code herum hinzugefügt und ist nur für C# und C++ verfügbar.

Suchen nach verfügbaren Codeausschnitten

Um die verfügbaren Codeausschnitte für eine Sprache anzuzeigen, wählen Sie denCodeausschnitt-Manager für > in der Menüleiste aus, oder drücken Sie STRG+K, B, und wählen Sie dann im Dropdownmenü die gewünschte Sprache aus.

Screenshot des Dialogfelds

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.

Hinzufügen eines Codeausschnitts zu einer Codedatei

So fügen Sie einer Codedatei einen Codeausschnitt hinzu:

  1. Platzieren Sie im Code-Editor den Cursor, oder wählen Sie C#- oder C++-Code aus, in dem Sie den Codeausschnitt hinzufügen möchten.

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

    • Wählen Sieauf der Menüleiste von Visual Studio die Option >"IntelliSense>Einfügen-Codeausschnitt bearbeiten" oder"IntelliSense>Surround With>" aus.
    • Klicken Sie mit der rechten Maustaste, und wählen Sie Codeausschnitt>einfügen oder Codeausschnitt>umgeben mit aus dem Kontextmenü.
    • Drücken Sie auf der Tastatur STRG+K, X für ein Erweiterungssnippet oder STRG+K, S für ein Surround-With-Snippet.

  3. Doppelklicken Sie auf den gewünschten Codeausschnitt in der Dropdownliste, oder geben Sie die Codeausschnittverknüpfung ein, und drücken Sie die TAB- oder EINGABETASTE.

Hinzufügen eines Erweiterungsausschnitts

Der C#-Erweiterungsausschnitt tryf fügt beispielsweise den folgenden Try...Finally Block hinzu:

try
{

}
finally
{

}

So fügen Sie diesen Erweiterungsausschnitt hinzu:

  1. Positionieren Sie im Code-Editor den Cursor an der Stelle, an der Sie den Codeausschnitt hinzufügen möchten.
  2. Klicken Sie mit der rechten Maustaste, und wählen Sie " Codeausschnitt einfügen" aus dem Kontextmenü aus, oder verwenden Sie die Menüleiste oder Tastaturbefehle.
  3. Öffnen Sie den Visual C# -Ordner, und doppelklicken Sie dann in der Dropdownliste auf tryf , oder wählen Sie tryf aus, und drücken Sie die TAB - oder EINGABETASTE.

Tipp

Sie können den Cursor auch an der Einfügemarke platzieren, tryf eingeben und dann zweimal die TAB-TASTE drücken.

Hinzufügen eines umgebenden Codeausschnitts

Im folgenden Beispiel eines C++-Codeausschnitts kann die Verknüpfung if entweder als Einfügeausschnitt oder als Surround-With-Codeausschnitt verwendet werden. Wenn Sie die Codezeile return FALSE; auswählen und dann "Surround With> if" wählen, wird der Codeausschnitt um die Zeile erweitert.

if (true)
{
    return FALSE;
}

Ausschnitt-Ersetzungsparameter

Codeausschnitte können Ersetzungsparameter enthalten, die Platzhalter sind, die Sie ersetzen müssen, um den Code anzupassen, den Sie schreiben. Im vorherigen Beispiel true handelt es sich um einen Ersetzungsparameter, den Sie durch die entsprechende Bedingung ersetzen. Die Ersetzung wird für jede Instanz dieses Ersetzungsparameters im Codeausschnitt wiederholt.

Beispielsweise verfügt Visual Basic über einen Codeausschnitt, der eine Eigenschaft definiert. So fügen Sie den Codeausschnitt ein:

  1. Wählen Sie im Kontextmenü in einer Visual Basic-Codedatei Codeausschnitt>Codeausschnitt einfügen aus.
  2. Wählen Sie Codemustereigenschaften>, Prozeduren, Ereignisse>definieren eine Eigenschaft aus.

Screenshot des Codeausschnittmenüs für

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 newPropertyValue zu m_property ändern, wird jede Instanz von newPropertyValue geändert. Wenn Sie String in der Eigenschaftsdeklaration zu Int ändern, ändert sich der Wert in der Set-Methode ebenfalls zu Int.

Bewährte Methoden für die Verwendung von Codeausschnitten

Der Code in einem Codeausschnitt zeigt nur die einfachste Möglichkeit, etwas zu erledigen. Für die meisten Anwendungen muss der Code entsprechend der Anwendung geändert werden.

Ausnahmenbehandlung

In der Regel blockiert Codeausschnitte Try...Catch alle Ausnahmen, aber dies ist möglicherweise nicht die richtige Wahl für Ihr Projekt. Für jede Ausnahme gibt es mehrere Möglichkeiten, zu reagieren. Beispiele finden Sie unter How to handle an exception using try/catch (C#) und Try... Catch... Finally-Anweisung (Visual Basic).

Dateispeicherorte

Wenn Sie Dateispeicherorte an Ihre Anwendung anpassen, sollten Sie die folgenden Faktoren berücksichtigen.

  • Suchen Sie einen barrierefreien Speicherort. Benutzer haben möglicherweise keinen Zugriff auf den Ordner "Programme" des Computers, sodass das Speichern von Benutzerdateien mit den Anwendungsdateien möglicherweise nicht funktioniert.

  • Suchen Sie einen sicheren Speicherort. Das Speichern von Dateien im Stammordner wie C:\ ist nicht sicher. Für Anwendungsdaten ist es am besten, den Anwendungsdatenordner zu verwenden. Für einzelne Benutzerdaten kann die Anwendung eine Datei im Ordner "Dokumente " jedes Benutzers erstellen.

  • Verwenden Sie einen gültigen Dateinamen. Sie können die Wahrscheinlichkeit ungültiger Dateinamen mithilfe der OpenFileDialogSaveFileDialog Steuerelemente verringern.

  • Beachten Sie, dass eine vom Benutzer ausgewählte Datei gelöscht werden kann, bevor Der Code die Datei bearbeiten kann. Außerdem verfügt ein Benutzer möglicherweise nicht über die Berechtigung zum Schreiben in die Datei.

Sicherheit

Die Sicherheit eines Codeausschnitts hängt davon ab, wo Sie ihn im Quellcode verwenden und wie Sie ihn ändern, sobald er sich im Code befindet. Die folgende Liste enthält einige zu berücksichtigende Bereiche:

  • Datei- und Datenbankzugriff
  • Codezugriffssicherheit
  • Schützen von Ressourcen wie Ereignisprotokollen und Registrierung
  • Speichern von Geheimnissen
  • Überprüfen von Eingaben
  • Übergeben von Daten an Skripttechnologien

Weitere Informationen finden Sie unter "Sichere Anwendungen".

Heruntergeladene Codeausschnitte

Codeausschnitte, die von Visual Studio installiert werden, sind selbst keine Sicherheitsrisiken. Sie können jedoch Sicherheitsrisiken in Ihrer Anwendung verursachen. Codeausschnitte, die aus dem Internet heruntergeladen wurden, sollten mit äußerster Vorsicht behandelt werden, wie alle anderen heruntergeladenen Inhalte. Laden Sie Codeausschnitte nur von Websites herunter, denen Sie vertrauen, und verwenden Sie up-to-date Virus-Software.

Öffnen Sie alle heruntergeladenen Codeausschnittdateien im Editor oder im XML-Editor von Visual Studio, und überprüfen Sie sie sorgfältig, bevor Sie sie installieren. Achten Sie auf die folgenden Probleme:

  • Codeausschnitt, der Ihr System beschädigen könnte, wenn Sie es ausführen. Lesen Sie den Quellcode sorgfältig, bevor Sie ihn ausführen.

  • HelpURL Blöcke in Codeausschnittdateien, die URLs enthalten, die schädliche Skriptdateien ausführen oder anstößige Websites anzeigen.

  • Codeausschnitte, die Verweise enthalten, die stillschweigend zu Ihrem Projekt hinzugefügt werden und von nahezu überall auf Ihrem System geladen werden können. Sie können diese Verweise von demselben Speicherort herunterladen, von dem Sie einen Codeausschnitt herunterladen. Der Codeausschnitt kann dann eine Methode in der Referenz aufrufen, die bösartigen Code ausführt. Um solche Verweise zu erkennen, überprüfen Sie die Blöcke Imports und References der Datei für Code-Snippets.

Verwandte Inhalte