Tool zum Erstellen von Dokumentation

l3u

Hallo :-)

Ich habe vor längerer Zeit die Dokumentation für meinem PHP-Spamfilter b8 geschrieben. Dazu hab ich eine HTML-Datei mit irgendwelchen Platzhaltern gemacht, und ein selbstgeschriebenes Perl-Script drüberlaufen lassen, was dann ein Inhaltsverzeichnis erstellt, die Querverweise und Literatur verlinkt hat. Das Ergebnis steht online: http://nasauber.de/opensource/b8/readme.htm

Das Problem ist jetzt, daß ich dieses Perl-Script nicht mehr finde, die Dokumentation aber für das nächste Release erheblich überarbeiten muß. Und deswegen meine Frage:

Wie erstellt man am besten so eine Anleitung? Da gibt's doch sicher Programme, die das können? Evtl. sogar was, das aus einer LaTeX-Datei dann so eine HTML-Datei baut?

Ich bin für alle Infos dankbar :-)

franzf · Advocate Joined: 29 Mar 2005 Posts: 4565

http://www.admin-wissen.de/no_cache/eigene-tutorials/webentwicklung/php-tutorial/automatische-dokumentation/?sword_list[]=ergebnis
Ich denke das gängigste ist doxygen. Damals entwickelt, um Doku zu bekommen wie die von Qt. Das von Trolltech entwickelte Tool wurde nicht freigegeben.
Ist wohl ziemlich umfangreich konfigurierbar, du kannst auch ein eigenes Template angeben, damit die Doku nicht 0815 ausschaut

Die Doku ist auch recht umfangreich, es gibt einige Seiten die den Umgang beschreiben.

http://de.wikibooks.org/wiki/C%2B%2B-Programmierung:_Dokumentation_mit_Doxygen

Necoro · Veteran Joined: 18 Dec 2005 Posts: 1912 Location: Germany

Für PHP direkt gibts auch noch http://www.phpdoc.org/ ... laut Eigenaussage "the current standard auto-documentation tool for the php language"

/edit:

Wenn dir API nicht so wirklich wichtig ist und du nur ne nette Doku schreiben willst, schau dir mal http://en.wikipedia.org/wiki/Restructured_Text an ... Evtl auch gleich Sphinx als Framework (dunno wie viel Arbeit das denn ist ... aber zum Beispiel ist die komplette Python-Doku mit Sphinx erstellt)
_________________
Inter Deum Et Diabolum Semper Musica Est.

l3u · Posted: Tue Feb 23, 2010 7:03 pm Post subject:

Ich will weniger die API beschreiben, auch wenn im Quellcode diese doxygen-Strings drin sind. Diese Restructured-Text sieht eigentlich genau nach dem aus, was ich will! Danke für den Tip, das werd ich mir mal näher ansehen!

Edit: reStructuredText ist genau das, was ich suche! Super, danke :-)

pablo_supertux · Posted: Wed Feb 24, 2010 1:07 am Post subject:

ich finde asscidoc einfacher zu bedienen, aber die HTML Ausgabe von Sphinx ist eindeutig schöner.
_________________
A! Elbereth Gilthoniel!
silivren penna míriel
o menel aglar elenath,
Gilthoniel, A! Elbereth!

Yamakuzure

l3u