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

[s-off]

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 ;)

[RavenIV]

Du könntest Dir ein Form zwischenschieben.

Ein "TBaseForm", das von TForm abgeleitet ist.
Da hinein schreibst Du alle "nicht sichtbaren" Methoden.

Dann ein myForm, das von TBaseForm abgleitet ist.
Hier sind alle "sichtbaren" Methoden.

Dann lässt Du den Documenter nur über myForm drüberlaufen.
Und schon sind im Dokument nur die "sichtbaren" Funktionen beschrieben.

[mkinzler]

Du könntest ja DelphiDoc an deine Bedürfnisse anpassen

[s-off]

Danke erstmal Ihr beiden für Eure Antworten:

@Raven
Der Weg würde sicherlich funktionieren, ist aber nicht praktikabel, da mir persönlich zu umständlich ;)

@mkinzler
Ha, gar nicht gesehen, dass das Tool unter Delphi geschrieben ist :-D
Sollten keine bereits existenten Alternativen mehr kommen, werde ich mich da wohl mal ran machen.

[TBx]

PasDoc kann das übrigens auch über die @exclude-Anweisung :-)

Gruß

[s-off]

Zitat:

Zitat von onlinekater

PasDoc kann das übrigens auch über die @exclude-Anweisung :-)

Tatsache :thumb: :bounce1: :dancer:

Super, vielen Dank.

[Muetze1]

Und Doc-O-Matic hat eine entsprechende Indizierungsübersicht mit Häkchen für Aufnahme der Doku und in die TOC. Dies ist für jedes gefundene Element aufgelistet, somit sollte das kein Problem darstellen.

Zur anderen Möglichkeit kannst du Zeichen(folgen) etc definieren, welche den Parser das folgende Element ignorieren lassen. Dies ist aber in der Projektkonfiguration einzelnd und detailliert einstellbar.

[s-off]

Zitat:

Zitat von Muetze1

Und Doc-O-Matic hat eine entsprechende Indizierungsübersicht mit Häkchen für Aufnahme der Doku und in die TOC. Dies ist für jedes gefundene Element aufgelistet, somit sollte das kein Problem darstellen.

Zur anderen Möglichkeit kannst du Zeichen(folgen) etc definieren, welche den Parser das folgende Element ignorieren lassen. Dies ist aber in der Projektkonfiguration einzelnd und detailliert einstellbar.

Diese Möglichkeiten scheint es allerdings nur in der kostenpflichtigen Professional-Version zu geben.
Die Express-Version bietet lediglich die Möglichkeit, gezielt Kommentare zu ignorieren.

[Muetze1]

Zitat:

Zitat von s-off

Diese Möglichkeiten scheint es allerdings nur in der kostenpflichtigen Professional-Version zu geben.
Die Express-Version bietet lediglich die Möglichkeit, gezielt Kommentare zu ignorieren.

Oh, ich benutze eine ältere Professional Edition, ich wusste noch nichtmal, dass es nun auch solche kostenlosen Versionen gibt. Damals zumindest nicht, von daher ging ich von einer Professional Lizenz aus. Sorry.

[s-off]

Danke trotzdem, für den Hinweis, dass D-o-M das in der Pro-Version kann. So kann ich das im Hinterkopf behalten; vielleicht gibt es ja irgendwann mal eine ältere Version kostenlos auf irgendeiner Heft-CD oder so.