Einzelnen Beitrag anzeigen

s-off
(Gast)

n/a Beiträge
 
#1

Tool gesucht: Komponenten-Doku mit Ausschluß spez. Elemente

  Alt 4. Mär 2008, 14:13
Hallo zusammen,

ich möchte für eine von mir erstellte Komponente eine Hilfedatei/Dokumentation erzeugen.

Habe diesbezüglich schon einige Tools ausprobiert, die hier im Forum vorgeschlagen worden sind, wie bspw. Doc-o-Matic (Express-Version), Together, JADD, pasdoc...

Mit diesen Tools ist es auch wunderbar möglich, eine Dokumentation für seinen Quellcode zu erzeugen, doch ein Feature fehlt mir bei allen: eine Möglichkeit, einzelne Elemente (Klassen, Felder, Properties, Methoden...) von der Dokumentation auszuschliessen.

Bei einigen dieser Tools ist es zwar möglich, Elemente nach Sichtbarkeit (private, published...) auszuschliessen; das ist mir aber nicht dynamisch genug.

Was ich mir vorstelle, wäre bspw. eine kurze Kennzeichnung innerhalb des Kommentars zu dem Element, an der das Tool dann erkennen soll, dass dieser Teil nicht in die Dokumentation einfließen soll. Das könnte in etwa so aussehen:
Delphi-Quellcode:
   TForm1 = Class(TForm)
   public
      //%NO% Diese Methode soll von dem Dokumentierer nicht übernommen werden
      Function NichtSichtbar: String;

      //Diese Methode soll von dem Dokumentierer übernommen werden
      Function Sichtbar: String;
   End;
Natürlich könnte man die generierte Dokumentation im Nachhinein noch editieren; das ist aber wohl nicht im Sinne des Erfinders.

Kennt jemand eine Software, die das unterstützt, oder habe ich bei den von mir getesteten evtl. nur etwas übersehen?

Programme wie bspw. den Modelmaker und Derivate in der Preisklasse bitte außen vorlassen - die Komponente soll als Freeware vertrieben werden
  Mit Zitat antworten Zitat