Hilfedateien zu eigenen Komponenten schreiben und zur Verfügung stellen

[mjustin]

Eine interessante Alternative zur F1 Hilfe mit dem Namen "Documentation Insight" wird seit einigen Tagen unter http://www.devjet.net/category/produ...ation-insight/ für RAD Studio 2007/2010/XE als Beta 2 angeboten.

Dabei handelt es sich um einen WYSIWYG Editor für die XML Dokumentation in Delphi Quelltexten.

Dazu ist kein "Compilieren" der Hilfe in irgendein Hilfe-Viewer Format erforderlich, die Delphi IDE selber stellt die Hilfe dar. Diese auf XML basierende Hilfe wird sofort angezeigt wenn der Entwickler im Quelltext auf ein Symbol (z.B. Klassen oder Methodennamen) zeigt, und der Quelltext der referenzierten Klasse vorhanden ist.

Welche "Tags" die Delphi XML Dokumentation unterstützt, hat der Autor in einem ausführlichen PDF Dokument beschrieben das unter http://www.devjet.net/downloads/Delp...Guidelines.pdf erhältlich ist.

Nick Hodges hat diese Plugin bereits wärmstens empfohlen (https://forums.embarcadero.com/threa...threadID=44664). Ich habe es selber noch nicht testen können, aber es sieht nach einer soliden Lösung aus.

Hope this helps

[pustekuchen]

Schau dir mal http://dephicodetodoc.sourceforge.net damit kannst du dir eine Hilfe Datei erstellen lassen.

[sgbSoftwareEntwickler]

Danke für die raschen Antworten.

Zitat von mjustin:

Eine interessante Alternative zur F1 Hilfe mit dem Namen "Documentation Insight" wird seit einigen Tagen unter http://www.devjet.net/category/produ...ation-insight/ für RAD Studio 2007/2010/XE als Beta 2 angeboten.
....
Ich habe es selber noch nicht testen können, aber es sieht nach einer soliden Lösung aus.

Hope this helps

Ich werde es (evtl. noch heute) testen. Für die neuen Dateien sicherlich sehr Interessant.

Zitat von pustekuchen:

Schau dir mal http://dephicodetodoc.sourceforge.net damit kannst du dir eine Hilfe Datei erstellen lassen.

Genau da liegt das Problem: erstellen lassen geht nicht ^^

Ich habe hier rund 32.000 Quellcodedateien (ca 1,6 GB). Selbst wenn ich nur die Allgemeinen Units nehme, sind es ca 6.000 Dateien die ich per Hand? nachziehen müsste. Wenn ich die Projekte einzeln bearbeite(n lasse) kostet das zu viel Zeit.

Ich will mir ein Tool schreiben, dass die Dateien nach (inividuellen und verschiedenen, unformatierten) Kommentaren scant, und diese passend aufbereitet und registriert, so das (neue)Kollegen die Hilfedateien nur registrieren brauchen und dann gleich eine Hilfe zu unseren Dateien zur Verfügung haben.

Bisher sehe ich nicht, welches Tool genau dies leistet.

[Dezipaitor]

Zitat von sgbSoftwareEntwickler:

Bisher sehe ich nicht, welches Tool genau dies leistet.

Ich muss dich entäuschen. Du hast ein ganz spezielles Problem und erwartest, dass nun irgendein Tool dieses Problem für dich löst. Ziemlich unwahrscheinlich. Aber vielleicht hast du mit den folgenden Tools Glück?

Zitat von sgbSoftwareEntwickler:

Ich will mir ein Tool schreiben, dass die Dateien nach (inividuellen und verschiedenen, unformatierten) Kommentaren scant, und diese passend aufbereitet und registriert, so das (neue)Kollegen die Hilfedateien nur registrieren brauchen und dann gleich eine Hilfe zu unseren Dateien zur Verfügung haben.

Darauf wird es hinauslaufen. Ich kenne das Format deiner Kommentare nicht. PasDoc verwendet z.B.

Delphi-Quellcode:

{<B>FindEqualACE</B> seeks for a ACE in the ACList.

     @param ACE defines the ACE to be searched for in the list.
     @param EqualACETypeSet defines the criterias that are used to compare the ACE.
       The following criterias are available and can be combined in a set.

           # eactSameSid    The SID is used to compare (EqualSID) and must be equal
           # eactSameFlags The Flags are compared and must be equal
           # eactSameAccessMask The AccessMasks are compared and must be equal
           # eactSameType The ACE type (deny, allow) are compared and must be equal
     @param StartIndex defines the start position for the search in the ACL list starting from zero (0).
     @param Inclusion Is currently not used.
     @param Exclusion Is currently not used.

     @return Returns the position of the found ACE in the list starting from 0.
             If the value iPos is out of bounds, or the ACE could not be found the return value is -1
     }

Und dann gibt es doch Doc-O-Matic, welches ein eigenes Format, JavaDoc und Pasdoc unterstützt.

Welches Format nutzt du?

[sgbSoftwareEntwickler]

Ich seh schon, habe mein Problem ungünstig formuliert.

Ziel ist es, folgende Schritte, z.B. in einem Dienst, zu automatisieren. Also quasi ein geplanter Task oder ein Doppelklick und das eigene Programm erstellt/aktuallisiert meine Hilfe Datei aus meinen Quelldateien.

Schritt 1: Dateien Scannen und Funktionen mit Kommentaren in eine (html/xml) Datei schreiben.
Lösung: selber schreiben.

Schritt 2: Aus diesen Dateien eine *.hxs selber erzeugen/compileren/packen
Lösung: ?

Schritt 3: Die Pfade / die *.hxs registrieren damit sie in der Hilfe über F1 aufrufbar sind.
Lösung: evtl. h2Reg.exe oder selber schreiben

Ich will genau den Part, den DocOMatic oder die anderen Programme im Hintergrund laufen lassen, selber schreiben

Zitat von Dezipaitor:

... Ich kenne das Format deiner Kommentare nicht ...

Tja, ich auch nicht , aber da werde ich mir noch etwas einfallen lassen. Es geht darum Altbestände zu erfassen. Für neuen Code wird natürlich ein Format festgelegt.