Einzelnen Beitrag anzeigen

mjustin

Registriert seit: 14. Apr 2008
3.006 Beiträge
 
Delphi 2009 Professional
 
#6

AW: Tool zum Überprüfen von Dokumentation von Methoden

  Alt 13. Feb 2015, 08:57
Für Dokumentation benutze ich Doxygen (www.doxygen.org), das diverse Dokumentationsstile unterstützt. Es validiert die Dokumentation und schreibt Hinweise in eine Logdatei.
Code:
BTJMSConnection.pas:647: warning: argument 'Text' of command @param is not found in the argument list of TBTJMSSession::CreateTextMessage
Um es mit Delphi einzusetzen benutze ich den pas2dox Preprozessor. Beide Tools sind Free Open Source. Pas2dox wird anscheinend nicht mehr weiterentwickelt, kleinere Mängel die sich durch den pas2dox Preprozessor Schritt ergeben sind aber bisher noch im Rahmen geblieben.
Doxygen erzeugt ohne Einsatz von Zusatztools auch Vererbungsdiagramme, zu sehen zum Beispiel hier.

Documentation Insight enthält laut Feature Matrix eine Documentation Validation, leider konnte ich dazu keine nähere Beschreibung finden. Ich würde gerne auf Documentation Insight umstellen, muss dazu aber erst meine JavaDoc-Stil Kommentare auf XML Kommentare umstellen.
Michael Justin
habarisoft.com

Geändert von mjustin (13. Feb 2015 um 09:04 Uhr)
  Mit Zitat antworten Zitat