C # Art XML-Kommentare in Delphi 2010
-
18-09-2019 - |
Frage
hat Delphi 2010 hat C # Art XML-Kommentare, die oben zeigen, wenn sie über den Methodenaufruf schweben?
/// <summary>
/// My comment here
/// </summary>
Lösung
Ich habe gerade versucht es in D2007 und es funktioniert. Ich habe den Test Kommentar über einer Methodendeklaration (innerhalb der Klassendeklaration) und wieder aufgebaut. Wenn Sie jetzt über einen Anruf schweben zu dieser Methode finden Sie „Mein Kommentar hier“ in der Tooltip sehen.
Sie müssen die HTML-Auswertung thingie für diese Funktion aktiviert haben, zu arbeiten. Siehe Optionen -> Editor-Optionen -> Code Insight. -> Symbolbeschreibung (übersetzt fron ein deutsches IDE)
Andere Tipps
Es funktioniert - in Delphi 2007 und 2009 gibt es Probleme mit ihm - Sie vor jeder Klasse eine Art keywork haben müssen, oder es nimmt nur den ersten Satz von Dokumentation aus (keine Ahnung warum), und wenn Sie auf die Schaltfläche ‚Build XML-Dokumentation‘ Option, so scheint es, verloren zu gehen, wenn viele Einheiten zusammenzustellen und gibt - ich hoffe, dass dies in Delphi fixiert ist 2010.
Having said that Dokumentation Inline ist besser als gar keine Dokumentation überhaupt nicht!
Dieser Link Embarcadero über die einzige Sache ist, die ich finden kann, obwohl ich glaube, gibt es Dienstprogramme in dem Architekten und Enterprise-Versionen von Delphi externer Dokumentation zu erzeugen.