Anzeigen von XML-Codekommentaren
Codekommentare beziehen sich auf Kommentare in Quellcodedateien, die Benutzern der integrierten Entwicklungsumgebung (Integrated Development Environment, IDE) über das IntelliSense-Feature zur Verfügung stehen.
[Visual Basic]
XML-Codekommentare sind in Visual Basic über das '''-Trennzeichen (drei einfache Anführungszeichen) verfügbar. Weitere Informationen hierzu finden Sie unter Gewusst wie: Erstellen einer XML-Dokumentation in Visual Basic.
[C#, J#]
Zum Kommentieren von Code können Sie die XML-Dokumentationsfeatures verwenden. Wenn Sie Typen und Member, die in den Quelldateien Ihrer Projektmappen definiert sind, mit XML-Dokumentationskommentaren versehen, werden diese Kommentare über IntelliSense-Features angezeigt, z. B.:
Tipp
Beim Kommentieren von partiellen Methoden werden in IntelliSense-Features nur Kommentare angezeigt, die sich in der Implementierung, nicht aber in der Definition befinden.
Weitere Informationen finden Sie unter XML-Dokumentationskommentare (C#-Programmierhandbuch).
[C++]
Standardmäßig werden alle Kommentare in Quellcode, die sich hinter den Trennzeichen // oder /* befinden, neben dem zugehörigen Member in der Memberliste angezeigt. Weitere Informationen finden Sie unter C++ Comments und XML Documentation (Visual C++).
Beim Durchführen eines Bildlaufs in der Liste zeigt IntelliSense bis zu 12 Kommentarzeilen in einem Popupfenster direkt neben dem hervorgehobenen Member an: Wenn für eine Funktion mehrere Kommentare vorhanden sind, wählt IntelliSense den in der Memberliste anzuzeigenden Kommentar danach aus, wo sich die Funktion im Code befindet:
IntelliSense zeigt zuerst den Kommentar am Zeilenende der Deklaration an. Beispiel:
void MyFunction(); //EOL declaration commentsWenn der oben beschriebene Kommentartyp nicht im Code vorhanden ist, zeigt IntelliSense die Kommentarzeilen an, die sich unmittelbar (ohne Leerzeilen) über der Deklaration befinden. Beispiel:
//Before declaration comments void MyFunction();Wenn die beiden oben beschriebenen Kommentartypen im Code nicht vorhanden sind, zeigt IntelliSense die Kommentare am Zeilenende der Definition an. Beispiel:
int CMyAppDoc::MyVariable=2; // EOL definition commentsWenn keiner der oben beschriebenen Kommentartypen im Code vorhanden ist, zeigt IntelliSense Kommentare an, die sich unmittelbar (ohne Leerzeilen) über der Definition befinden. Beispiel:
//Before definition comments CMyAppDoc::MyFunction() { return; }