Dokumentation
PlatzhalterPlatzhalter
Über Platzhalter im Code eines Codeausschnittes lässt sich das Verhalten eines Platzhalters steuern. Hier eine Übersicht.
$(selection)
Dieser Platzhalter wird durch aktuelle Auswahl ersetzt. Arbeitet ähnlich wie die Angabe von Einfügemarken durch »|« (senkrechte Striche), mit dem Unterschied, dass kein Standardwert angegeben werden kann. Siehe erste Zeile der folgenden Tabelle im Vergleich zur dritten Zeile:
| Codeausschnitt | Im Dokument selektiert | Ergebnis |
|---|---|---|
<h1>Hallo, $(selection)!<h1> |
(nichts) | Hallo, ! |
<h1>Hallo, $(selection)!<h1> |
Sie | Hallo, Sie! |
<h1>Hallo, |Welt|!<h1> |
(nichts) | Hallo, |Welt|! |
<h1>Hallo, |Welt|!<h1> |
Sie | Hallo, Sie! |
$(selection) sollte immer dann benutzt werden, wenn der Codeausschnitt senkrechte Striche
enthält, die gerade nicht als Einfügemarken interpretiert werden sollen. Sobald $(selection) im
Code definiert ist, werden Einfügemarken ignoriert.
$(now[;format="Formatangabe"])
Fügt das aktuelle Datum oder die aktuelle Uhrzeit ein. Über die optionale Formatangabe kann die Ausgabe angepasst werden (ohne Formatangabe wird das aktuelle Datum in Kurzform ausgegeben). Eine komplette Übersicht der verfügbaren Formate findet sich bei Microsoft. Hier nur eine kleine Auswahl:
| Platzhalter | Ausgabe | Kommentar |
|---|---|---|
$(now) |
13.04.2009 | Standardeinstellung |
$(now;format="d") |
13.04.2009 | Kurzes Datumsformat |
$(now;format="D") |
Montag, 13. April 2009 | Langes Datumsformat |
$(now;format="f") |
Montag, 13. April 2009 13:46 | Langes Datumsformat und kurzes Zeitformat |
$(now;format="F") |
Montag, 13. April 2009 13:46:30 | Langes Datumsformat und langes Zeitformat |
$(now;format="dd.MM.yyyy") |
13.04.2009 | Datum in deutscher Schreibweise |
$(now;format="MM\/dd\/yyyy") |
04/13/2009 | Datum in englischer Schreibweise |
$(prompt:Variable)
Definiert eine Variable, deren Wert vor dem Einfügen des Codesauschnittes in ein Dokument abgefragt wird.
Beispiel
Ich benutze zur Dokumentation meiner CSS-Stylesheets die CSSDoc-Konventionen, sowie als Anschauungsobjekt die hervorragende Dokumentation des YAML-Frameworks, in der u.a. auch mehrsprachige Kommentare definiert sind. Ein einfacher, einzeiliger Kommentar für Deutsch und Englisch habe ich als Codeausschnitt in dieser Form definiert:
/* (en) $(prompt:en) | (de) $(prompt:de) */ $(selection)
Füge ich diesen Codeausschnitt in eine (CSS-) Datei ein, erscheint zunächst folgender Dialog:
Für
jede Variable kann in diesem Dialog der einzusetzende Inhalt festgelegt werden.
Hinweis
Wie Sie sehen, beinhaltet der Code des Codeausschnitts einen senkrechten Strich, um den englischen von dem
deutschen Kommentar zu trennen. Um zu verhindern, dass dieser Strich als Einfügemarke interpretiert wird,
verwende ich $(selection) anstatt |...| um die aktuelle Auswahl im Code
einzufügen.
Das Ergebnis sieht dann so aus:
/* (en) english comment sample | (de) Beispiel Deutscher Kommentar */
$(clipboard)
Fügt den Textinhalt der Zwischenablage ein.
