Symbolbeschreibung

Aus RAD Studio
Wechseln zu: Navigation, Suche

Nach oben zu Menü Ansicht

Ansicht > Symbolbeschreibung    Umsch+Strg+H

Zeigt Informationen zum aktuellen Symbol an, z.B. Typ, Datei, Zeilennummer der Deklaration und die dem Symbol zugeordnete XML-Dokumentation (falls vorhanden).

Sie können die Symbolbeschreibung auch aufrufen, indem Sie die Maus im Quelltext-Editor über einen Bezeichner führen oder Strg+Umsch+H drücken.

Beispiel für Funktionen

Im folgenden Beispiel zeigt die Symbolbeschreibung XMLDOC-Kommentare für eine Funktion an. Sie können daraus entnehmen, wie Parameterinformationen (das Tag <param>) und Exception-Informationen (das Tag <exception>) geschrieben werden:

XML Doc Comment Help Insight for Function.PNG

Beispiel für Klassen

Im folgenden Beispiel zeigt die Symbolbeschreibung XMLDOC-Kommentare für eine Klasse an. Sie können daraus entnehmen, wie Referenzen (das Tag <see>) und Anmerkungen (das Tag <remarks>) vorgenommen werden:

XML Doc Comment Help Insight.PNG

Siehe auch