9.7 Codeausschnitte (Code Snippets)

Ein Codeausschnitt (Code Snippet) ist eine Art Makro, das ein Quelltextfragment erzeugt und so Tipparbeit spart. Code Snippets können Sie auf drei verschiedene Arten einfügen:

• Im Code tippen Sie den Bezeichner eines Ausschnitts und drücken dann die -Taste.

• Sie wählen aus der Liste, die der Menüpunkt Ausschnitt einfügen des Kontextmenüs hervorbringt.

• Dieselbe Liste erzeugt das Menü Bearbeiten • IntelliSense • Ausschnitt einfügen

Teils sind die Codeausschnitte Vorlagen, die Sie anpassen müssen. Abbildung 9.18 zeigt eine so hinzugefügte For-Schleife.

Abbildung 9.18 Durch ein Code Snippet hinzugefügte For-Schleife

9.7.1 Anatomie

Bei Codeausschnitten handelt es sich um XML-Dateien mit der Dateinamenserweiterung .snippet. Wir wollen uns nun exemplarisch die Datei ansehen, die für den Codeausschnitt einer If-Bedingung verantwortlich ist:

<Programme>\Microsoft Visual Studio 9.0\VB\Snippets\1031\common code patterns\
conditionals and loops\IfEndifStatement.snippet

<?xml version="1.0" encoding="UTF-8"?> 
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet"> 
  <CodeSnippet Format="1.0.0"> 
    <Header> 
      <Title>If..End If Statement</Title> 
      <Author>Microsoft Corporation</Author> 
      <Description>Inserts an If..End If statement.</Description> 
      <Shortcut>If</Shortcut> 
    </Header> 
    <Snippet> 
      <Imports></Imports> 
      <Declarations> 
        <Literal> 
          <ID>Condition</ID> 
          <Type>Boolean</Type> 
          <ToolTip>Replace with an expression that evaluates to either True or  
          False.</ToolTip> 
          <Default>True</Default> 
        </Literal> 
      </Declarations> 
      <Code Language="VB" Kind="method body"><![CDATA[If $Condition$ Then

End If]]></Code> 
    </Snippet> 
  </CodeSnippet> 
</CodeSnippets>

In der Dokumentation finden Sie unter dem Stichwort Schemareferenz für Codeausschnitte weitere Informationen.

9.7.2 Eigene Codeausschnitte

Von den Tags sind nur wenige wirklich notwendig, sodass eigene Ausschnitte schnell erstellt sind. Beachten Sie, dass der Inhalt eines CDATA-Abschnitts wörtlich in das Dokument übernommen wird, inklusive aller Leerzeichen. Der <Title>-Abschnitt ist das, was in der IntelliSense-Liste angezeigt wird. Hier ein einfaches Beispiel.

<?xml version="1.0" encoding="utf-8"?> 
<CodeSnippets xmlns="..."> 
  <CodeSnippet Format="1.0.0"> 
    <Header> 
      <Title>Fehlermeldung</Title> 
    </Header> 
    <Snippet> 
      <Code Language="VB"> 
        <![CDATA[Console.WriteLine("Es ist ein Fehler aufgetreten")]]> 
      </Code> 
    </Snippet> 
  </CodeSnippet> 
</CodeSnippets>

Mit dem Codeausschnitt-Manager machen Sie den Ausschnitt verfügbar. Er wird über den Menüpunkt Extras • Codeausschnitts-Manager geöffnet. Bitte wählen Sie im oberen Listenfeld die richtige Sprache. Mit der Schaltfläche Importieren machen Sie den Ausschnitt bekannt.

Ihre Meinung

Wie hat Ihnen das Openbook gefallen? Wir freuen uns immer über Ihre Rückmeldung. Schreiben Sie uns gerne Ihr Feedback als E-Mail an kommunikation@rheinwerk-verlag.de.