Software-Dokumentationswerkzeug

aus Wikipedia, der freien Enzyklopädie

Wechseln zu: Navigation, Suche

Ein Software-Dokumentationswerkzeug dient zur automatischen Erzeugung von Dokumentationen aus den Ergebnissen und Objekten des Softwareentwicklungsprozesses. Die Dokumentation ist dabei jedoch keinesfalls nur auf den Quellcode beschränkt. Dokumentationswerkzeuge erlauben die Generierung von Dokumenten aus verschiedenen Quellen (z. B. UML-Diagramme, Quelltext), sie unterstützen verschiedene Layoutvorgaben und unterschiedliche Ausgabeformate (z. B. PostScript, PDF).

Ein sehr verbreitetes Software-Dokumentationswerkzeug für die Programmiersprache Java ist Javadoc. Doxygen dagegen wird gerne für C++ benutzt, ist aber ein Dokumentationswerkzeug, dass mehrere Sprachen und verschiedene Ausgabeformate wie z. B. LaTeX, HTML und PDF unterstützt. Ein ähnliches Dokumentationswerkzeug ist Natural Docs. Das in Perl geschriebene Dokumentationswerkzeug kommt — im Gegensatz zu Javadoc und Doxygen — jedoch ganz ohne Tags aus und versucht, die Dokumentation aus möglichst lesbaren, "natürlich" aussehenden Kommentaren zu erzeugen.

[Bearbeiten] Siehe auch

Persönliche Werkzeuge
Buch erstellen