Eigene Dokumentation schreiben

Werbeanzeige

Faule Socke

Community-Fossil

Beiträge: 1 915

Wohnort: Schreibtischstuhl

24.12.2006, 14:44

Eigene Dokumentation schreiben

Hi,

erstmal die vorgeschichte:

Ich hab ne Dll geschrieben die ich bald veröffentlichen will. Wenn ich weitere Informationen zum Projekt wollt bitte per pn an mich.
So nun gibt es das Problem das die leute die sich das Projekt dann runterladen es auch verwenden sollen und das möglichst ohne das sie sich in meine Quellcodes erstmal einlesen müssen. Ich habe also beschlossen(um auch selber den überblick zu bewahren) eine Dokumentation dazu zu schreiben(Als Kompilierte HTML HIlfe-Datei)...
HTML kann ich natürlich falls ich das dafür irgendwie brauche!

Frage: Wie kann ich das anstellen?

mfg,

Faule Socke

Zum Seitenanfang

Deviloper

Community-Fossil

Beiträge: 2 872

24.12.2006, 14:46

es gibt doch satt Programme dir erstmal ne doc generieren ... automatisch ... und du kannst die dann halt um nen paar weitere Informationen ergänzen ...

Devil Entertainment :: Your education is our inspiration
Der Spieleprogrammierer :: Community Magazin
Merlin - A Legend awakes :: You are a dedicated C++ (DirectX) programmer and you have ability to work in a team? Contact us!
Siedler II.5 RttR :: The old settlers-style is comming back!

Also known as (D)Evil

Zum Seitenanfang

Phili

unregistriert

24.12.2006, 14:47

was isn das für ne Frage?
Schreib auf, was deine Klasses/Funktionen für nen Sinn rfüllen, mach kleine Beispielcodes...

Zum Seitenanfang

Anonymous

unregistriert

24.12.2006, 14:49

Gehe auf XML und lasse dein dll auf wunsch eine XML Datei erstellen die alle nötigen Infos enthällt.

Es reicht einen XML Parser einzufügen und dein dll mit entsprechenen Infos auszukommentieren.

cu

Zum Seitenanfang

Faule Socke

Community-Fossil

Beiträge: 1 915

Wohnort: Schreibtischstuhl

24.12.2006, 15:34

An kommentaren habe ich net gespart aber es sind halt ne menge klassen und funktionen und es würde eventuell etwas dauern bis man das alles gefunden hat und deshalb würde des mit dem XML dings auch wenig sinn machen weil man dann ja auch nur informationen zu bekannten funktionen und klassen in die XML datei schreiben kann. Wenn man sie jetzt aber runtergeladne hat(als SDK) und dann wissen will was sie kann wäre so ne Doku(so wie in der Irrlicht oder in OGRE) halt gut! Ausserdem vergesse ich selber manchmal schon wie meine FUnktionen genau hiessen oder wie ich sie verwende. Bei letzterem hat mir Intelli-Sense zwar immer geholfen aber es wäre halt gut besonders für leute die eben net erst meinen quellcode lesen wollen sondern das SDK direkt benutzen wollen. Ich habe das projekt übrigens grade in WIP II Thread vorgestellt.

EDIT:

Deviloper
Ich versteh net ganz was du meinst... das klingt net nach gutem deutsch was du da geschrieben hast. Also würdest du es bitte nochmal präzisieren?

mfg,

Faule Socke