Hallo zusammen,
ich bin auf der Suche nach einem Tool für Delphi (in meinem Fall XE2), welches mir die Dokumentation von Methoden-Header im Sourcecode überwacht.
Folgendes Beispiel:
Bei uns im Projekt werden Methoden mit folgendem Header versehen, welcher kurz die Funktionsweise, wie auch die Aufrufparameter beschreibt:
Delphi-Quellcode:
{-------------------------------------------------------------------------------
Name : MyFunction
Info : Diese Methode macht .......
Input : Param1 = der Parameter ist zuständig für ....
Param2 = und dieser Parameter für jenes ...
Output : None
Result : None
-------------------------------------------------------------------------------}
procedure TForm1.MyFunction(Param1, Param2: Integer);
begin
// do something
end;
Wenn jetzt nachträglich an der Methode etwas geändert wird (z.B. eine Parameter hinzukommt oder wegfällt), dann stimmt die Dokumentation nicht mehr mit der eigentliche Methode überein. Hier wäre es jetzt toll, wenn es irgendein Tool gibt, welches mich darauf aufmerksam macht. Ich habe von einem Kollegen gehört, dass in C# sowas mit dem Resharper möglich ist.
Meine Frage:
Gibt es sowas ähnliches auch für Delphi?
Ich möchte hier jetzt auf keinen Fall eine Diskussion anstossen, wie sinnvoll welche Arten von Dokumentationen sind. Oder ob man besser die neue Form der
XML-Dokumentation verwendet oder nicht.
Ich möchte nur wissen, ob ich meine Kollegen hier dazu zwingen kann, ihre Dokumentation auf dem Laufenden zu halten, wenn sich am Code was ändert.
Vielen Dank schonmal, Hans.