Autor Beitrag
Maweki
ontopic starontopic starontopic starontopic starontopic starontopic starontopic starofftopic star
Beiträge: 197

Ubuntu Linux
Lazarus
BeitragVerfasst: Fr 28.07.06 01:26 
Hallo
ich programmiere im Moment ein Spiel. Nicht mit Delphi sondern in Lazarus mit dem Freepascal-Compiler. Aber das tut ja eher nichts zur Sache. Das Spiel ist von vornherein so angelegt, dass sich saemtliche Spielprozesse ueber Scripts (und spaeter die Konsole, die noch nicht programmiert ist) gesteuert werden. Nachdem ich jetzt ueber 1600 Zeilen geschrieben habe (Variablen u. Funktionsverwaltung, Grundkonsolenfunktionen), habe ich jetzt schon ein Dutzend Funktionen und ich denke, es werden spaeter ueber fuenfzig werden (kann ich jetzt gerade nicht abschaetzen).
Nun brauche ich ein Programm, mit dem ich eine moeglichst brauchbare Dokumentation fuer die Funktionen erstellen kann. Also eher ein allgemeines Dokumentationstool, als eines, was genau auf eine Sprache ausgelegt ist.
Waere echt cool, wenn da jemand was kennen wuerde, was meinen Anforderungen gerecht wird.
Danke im Voraus :)

Gruesse
Das Maweki

Edit: ich kann schon unglaeubige Gesichter sehen, die Sagen, "wie hat er das denn jetzt geloest" oder so...
Ich arbeite bei den Funktionen mit Methodenpointern und habe eine Liste von Objekten. Ein Objekt ist eine Funktion, was seinen Namen kennt und das Objekt hat einen Pointer auf die Methode. Im Grunde sieht das bei mir so aus:
ausblenden Delphi-Quelltext
1:
console.RegisterCommand('startdx', @gfxinit.DirectXWindowInit);					
digi_c
ontopic starontopic starontopic starontopic starontopic starontopic starhalf ontopic starofftopic star
Beiträge: 1905

W98, XP
D7 PE, Lazarus, WinAVR
BeitragVerfasst: Fr 28.07.06 07:37 
Suche in: Delphi-Forum WIE ERSTELLT IHR EURE DOKUMENTATIONEN hat eien sehr schöne Auflistung(aber auch für Hilfedateien) für Codeextraktion empfehle ich weiterhin DelphiDoc.
Maweki Threadstarter
ontopic starontopic starontopic starontopic starontopic starontopic starontopic starofftopic star
Beiträge: 197

Ubuntu Linux
Lazarus
BeitragVerfasst: Fr 28.07.06 16:35 
danke erstmal. Ich habe das jetzt alles durchgesehen und zur Quellcodedokumentation habe ich jetzt das richtige gefunden. Aber um die gesamte API und die Konsolenfunktionen zu erklaeren wuerde ich gerne ein hilfe-file erstellen. Jedoch ist die gesamte Software zum helpfiles erstellen nicht frei. Existiert irgendeine freie Alternative um das zu tun, was ich gerne tun moechte?
digi_c
ontopic starontopic starontopic starontopic starontopic starontopic starhalf ontopic starofftopic star
Beiträge: 1905

W98, XP
D7 PE, Lazarus, WinAVR
BeitragVerfasst: Mo 31.07.06 08:45 
Hehe da ist dir der HelpMaker entgangen, ist zwar nicht wirklich schmausig und bissel instabil aber das einzige was WYSIWYG unterstütz und kostenlos ist.
Schade ist das es für Openoffice.org keinen Exporter gibt :(
MrSaint
ontopic starontopic starontopic starontopic starontopic starontopic starontopic starofftopic star
Beiträge: 1033
Erhaltene Danke: 1

WinXP Pro SP2
Delphi 6 Prof.
BeitragVerfasst: Mo 31.07.06 09:16 
Ich kanns nur immer wieder ankündigen: Ich schreibe gerade an einem Help-Authoring-Tool :) Aufgrund von Klausur-stress wird das aber diese Woche auf jeden Fall noch auf Eis liegen. Allgemein würd ich sagen, dass das Programm zu 60-70% fertig ist. Da jetzt aber dann Semesterferien sind hoffe ich, dass ich gut vorankomme mit dem Projekt :)
Es wird auch eine Freeware-Version von dem Programm geben, die ich dann natürlich hier in der Freeware Sparte vorstellen werde :D
Sobald es hier das nächste großere Update gibt (und wir dann hier Blogs haben), werde ich auch in diesem Blog über den Fortschritt berichten. Natürlich nur, wenn ich bis dahin nicht schon fertig bin...


MrSaint



EDIT: Mein Tool wird dann natürlich auch WYSIWYG können ;)

_________________
"people knew how to write small, efficient programs [...], a skill that has subsequently been lost"
Andrew S. Tanenbaum - Modern Operating Systems
digi_c
ontopic starontopic starontopic starontopic starontopic starontopic starhalf ontopic starofftopic star
Beiträge: 1905

W98, XP
D7 PE, Lazarus, WinAVR
BeitragVerfasst: Mo 31.07.06 09:26 
Mhh das ist cool :-) kannst du mal ein paar Details nennen? Nutzt du externe Compiler? Welchen Umfang wird das haben eher ein RTF Editor oder doch schon ein Robohelp ähnliches Tool? Und wird es OpenDocument verstehen?
MrSaint
ontopic starontopic starontopic starontopic starontopic starontopic starontopic starofftopic star
Beiträge: 1033
Erhaltene Danke: 1

WinXP Pro SP2
Delphi 6 Prof.
BeitragVerfasst: Mo 31.07.06 10:37 
Hmm... Also ich sag jetzt mal, dass es was neues wird. Mir ist kein Tool bekannt, das die Sache so angeht wie mein Tool das wird. Mehr verrat ich momentan noch nicht ;) Ich will ja nicht, dass das irgendwer nachprogrammiert...
Der Output besteht erstmal aus HTML-Dateien oder einer CHM Datei. Für später sind PDF, HLP und HxS angedacht. PDF wird was größeres, weil ich meine PDF-Erzeugung wohl selber schreiben muss :(. Und bei HLP und HxS kenn ich mich noch fast gar nicht aus, wie man das erzeugen kann, in sofern kann ich keine Angaben machen. CHM wird mit einem externen "Compiler" erzeugt werden, HTML werd ich selbst erzeugen.



MrSaint

_________________
"people knew how to write small, efficient programs [...], a skill that has subsequently been lost"
Andrew S. Tanenbaum - Modern Operating Systems
digi_c
ontopic starontopic starontopic starontopic starontopic starontopic starhalf ontopic starofftopic star
Beiträge: 1905

W98, XP
D7 PE, Lazarus, WinAVR
BeitragVerfasst: Mo 31.07.06 11:45 
HLP geht auch über den MS Help Compiler, der benötigt als input glaube ne .RTF

Na wenns Freeware wird freue ich mich schon jetzt :-) Aber bitte denke mal an OpenDocument Import ;-). Ein paar problemfälle für Doku Tools wurden in dem Thread ja schon angesprochen, vielleicht kann dein Tool die ja dann elegant lösen 8)