Das Plugin highlightet Kommentare bzw. deren Bezeichnungen/Schlüsselwörter und setzt vor der Zeilennnummer noch ein farbiges Kennzeichen. Zudem hat das Plugin noch ein paar coole Zusatzfunktionen.
Hier Codebeispiele zum kopieren.
/** * [epic= EpicTitle #20220913-094612] * >> Wird verwendet, um mehrere Kommentare auch verschiedenen Typs zusammenzufassen << * - [epic= ] = required. Es darf kein Leerzeichen zwischen epic und = sein. * - EpicTitle/Flag = required. Ein Title der die Zusammenfassung beschreibt. Leerzeichen erlaubt. * Der Titel muss mit den anderen zusammengeörigen epiic Kommentaren exakt übereinstimmen. * - #Date = notRequired but recommended. Wird ein Titel versehentlich oder wissentlich mehrfach verwendet, * soll aber episch nicht zusammengehören, empfielt sich hier eine forlaufende Nummer oder wie in diesem Beispiel * ein Datumsstring. * Epic Kommentare werden im (gesamten) Workspace angezeigt. */ /** * TODO[epic= Comment Anchors #20220913-094612] - Todo Kommentar Beispiel * >> Ein Abschnitt, das auf die Fertigstellung wartet << * - [epic=... ist optional */ /** * FIXME[epic= Comment Anchors #20220913-094612] - Fixme Kommentar Beispiel * >> Ein Abschnitt, das eine Fehlerbehebung erfordert << * - [epic=... ist optional */ /** * NOTE - Note Kommentar Beispiel * >> Ein wichtiger Hinweis für einen bestimmten Codeabschnitt << */ /** * REVIEW[epic= Comment Anchors #20220913-094612] - Review Kommentar Beispiel * >> Ein Element, das einer zusätzlichen Überprüfung bedarf << * - [epic=... ist optional */ /** * SECTION[epic= Comment Anchors #20220913-094612] - Section Kommentar Beispiel * >> Wird verwendet, um eine Region zu definieren << * - [epic=... ist optional */ // STUB - Wird für generierte Standard-Snippets verwendet. Keine Ahnung wofür. // !SECTION - Ende Section (Der Text in Ende Section wird nicht angezeigt) /** * LINK files4u/js/js4u.js:60 * >> Um auf Notizen (Anchors) oder Zeilennummern zu verlinken << * - Der Pfad und die Dateien müssen existieren! * - Zeilennummern und ANCHOR müssen nicht vorhanden sein. * - Nach dem Pfad darf nur die Zeilennummer oder die id stehen! Kein weiteres Zeichen. * - Ist die Syntax bei einem Link nicht so wie hier angegeben, funktionieren alle Link * - Kommentare in der Datei nicht mehr. * * Beispiele: * * Links mit Zeilennummern * LINK files4u/js/js4u.js:200 * * * Link auf Anchor * LINK[epic= Comment Anchors #20220913-094612] files4u\js\js4u.js#target */ /** * ANCHOR[id=target] - Anchor Komentar Beispiel * >> Sprungziel der Link Kommentare << * - Der Anchor sollte nur einmalig in einer Datei vorkommen. Bei mehreren Vorkommen in einer Datei, * - wird der letzte Anchor angesprungen. */
So sieht es dann in VSC aus.
