Gewusst wie: Erstellen von Kommentaren zur Aufgabenliste
Über die Aufgabenliste werden Kommentare im Code angezeigt, die mit dem Kommentarzeichen für die Entwicklungssprache beginnen. Neben den Kommentaren wird von der Aufgabenliste auch ein standardmäßiges Aufgabentoken, wie TODO, HACK oder UNDONE, bzw. ein benutzerdefiniertes Kommentartoken angezeigt. Die Anzahl der Kommentare, die in der Aufgabenliste angezeigt werden, kann sich je nach dem verwendeten Projekttyp ändern. Bei Visual Basic und Visual C# werden in der Aufgabenliste alle Kommentare in der Projektmappe angezeigt. Bei Visual C++-Projekten werden in der Aufgabenliste nur die Kommentare angezeigt, die in der im Editor zurzeit aktiven Datei gefunden werden.
Kommentare zur Aufgabenliste können für Hinweise auf eine Vielzahl von Aufgaben verwendet werden, die an der gekennzeichneten Position ausgeführt werden müssen:
Hinzufügen von Features
Korrigieren von Problemen
Implementieren von Klassen
Platzieren von Markern für Fehlerbehandlungscode
Überprüfen von Erinnerungen in der Datei
Wie bei anderen Einträgen in der Aufgabenliste können Sie auf einen beliebigen Kommentar doppelklicken, um die im Code-Editor angegebene Datei anzuzeigen und zur gekennzeichneten Codezeile zu wechseln.
So fügen Sie der Aufgabenliste einen Kommentar hinzu
Öffnen Sie eine Quellcodedatei im Code-Editor.
Beginnen Sie einen Kommentar in einer zu kennzeichnenden Codezeile mit <marker><token>, wobei <marker> dem Kommentarzeichen für die Entwicklungssprache und <token> dem Namen eines erkannten Kommentartokens für die Aufgabenliste, beispielsweise TODO, HACK oder UNDONE, bzw. einem benutzerdefinierten Kommentartoken entspricht.
Tipp
Um Aufgabentoken programmgesteuert hinzuzufügen, legen Sie DefaultCommentToken von TaskList fest.
Vervollständigen Sie den Kommentar mit Text zur Beschreibung der Aufgabe. Beispiel:
// TODO Fix this function.– oder –
' HACK Update this procedure.Klicken Sie im Menü Ansicht auf Aufgabenliste.
Die Aufgabenliste wird angezeigt.
Klicken Sie in der Liste Kategorien auf Kommentare.
In der Liste Kommentare wird der Kommentartext angezeigt. Sie können auf einen beliebigen Kommentar in der Aufgabenliste klicken, um die Datei im Code-Editor zu aktivieren und zu der durch den Kommentar gekennzeichneten Codezeile zu wechseln.
So ändern Sie einen Kommentar oder entfernen ihn aus der Aufgabenliste
Öffnen Sie eine Codedatei zur Bearbeitung im Code-Editor.
Ändern oder entfernen Sie den Kommentar im Code.
So ändern Sie die Standardpriorität eines Kommentars
Klicken Sie im Menü Extras auf Optionen.
Erweitern Sie den Ordner Umgebung, und klicken Sie dann auf Aufgabenliste.
Wählen Sie unter Tokenliste das Kommentartoken aus, dessen Standardpriorität Sie ändern möchten.
Tipp
Sie können die Priorität für TODO-Kommentare nicht ändern.
Wählen Sie in der Dropdownliste Priorität einen anderen Prioritätstyp aus.
Klicken Sie auf OK.
So erstellen Sie ein benutzerdefiniertes Kommentartoken
Klicken Sie im Menü Extras auf Optionen. Erweitern Sie den Ordner Umgebung, und klicken Sie dann auf Aufgabenliste.
Aufgabenliste, Umgebung, Dialogfeld "Optionen" wird angezeigt.
Geben Sie im Feld Kommentartoken unter Name einen Namen für das benutzerdefinierte Token ein.
Wählen Sie aus der Liste Priorität eine der Optionen Normal, Niedrig oder Hoch aus.
Klicken Sie auf Hinzufügen und anschließend auf OK.
Weitere Informationen zum Hinzufügen benutzerdefinierter Token zur Tokenliste finden Sie unter Gewusst wie: Erstellen benutzerdefinierter Kommentartoken.
Beispiel
// The following C# code file contains several TODO reminders.
// Note that each line task reminder begins, like this comment,
// with the C# comment indicator, '//'.
// TODO: Add standard code header comment here.
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Windows.Forms;
// TODO: Add references to specific resources here.
namespace TodoExample
{
partial class TodoExample : Form
{
public TodoExample()
{
InitializeComponent();
}
}
}
// TODO: It is even possible to add comments at the end.
Das Beispiel veranschaulicht, dass Sie TODO-Kommentare in einer Codedatei an einer beliebigen Stelle einfügen können. Über Kommentare zur Aufgabenliste können Sie am besten Anweisungen zu den Aufgaben einfügen, die für bestimmte Codezeilen oder -abschnitte ausgeführt werden müssen. Für längere Beschreibungen allgemeiner Entwicklungsaufgaben sind sie weniger geeignet.
Siehe auch
Aufgaben
Gewusst wie: Festlegen von Lesezeichen im Code
Gewusst wie: Steuern der Aufgabenliste
Referenz
Anzeigen von XML-Codekommentaren