Dokumentationsgenerator
A Dokumentationsgenerator ist ein Programmierwerkzeug das erzeugt Softwaredokumentation für Programmierer bestimmt (API -Dokumentation) oder Endbenutzer (Endbenutzer Leitfaden) oder beides von einem Satz von Quellcode Dateien und in einigen Fällen, Binärdateien. Einige Generatoren, wie z. Javadoc, kann speziell verwenden Kommentare die Generation fahren. Doxygen ist ein Beispiel für einen Generator, der alle diese Methoden anwenden kann.
Arten der Generation
Die Erzeugung der Dokumente kann in mehreren Typen geteilt werden:
- Batch -Generierung (Generische Technik)
- Textblockkorrespondenz (Dokumente, die basierend auf vordefinierten Textblöcken erstellt wurden)
- Formulare (Formulare für Websites)
- Dokumentationssynthese:
Etwas Integrierte Entwicklungsumgebungen Bieten Sie interaktive Zugriff auf Dokumentation, Codemetadaten usw.
Verweise
- ^ Bruch, Marcel; Mezini, Mira; Monperrus, Martin (2010). "Bergbau -Subklassifizieren zur Verbesserung der Wiederverwendung von Framework". 2010 7. IEEE -Arbeitskonferenz über Bergbau -Software -Repositories (MSR 2010). S. 141–150. doi:10.1109/msr.2010.5463347. ISBN 978-1-4244-6802-7.
- ^ Zhang, Sai; Zhang, Cheng; Ernst, Michael (2011). "Automatisierte Dokumentation Inferenz zur Erklärung fehlgeschlagener Tests" (PDF). 2011 26. IEEE/ACM Internationale Konferenz über automatisierte Software -Engineering (ASE 2011). S. 63–72. doi:10.1109/ase.2011.6100145. ISBN 978-1-4577-1639-3.
- ^ Hühner, Stefan; Monperrus, Martin; Mezini, Mira (2012). "Semi-automatisch Extrahieren von FAQs zur Verbesserung der Zugänglichkeit des Wissens von Softwareentwicklungen". 2012 34. Internationale Konferenz für Software Engineering (ICSE). S. 793–803. Arxiv:1203.5188. doi:10.1109/ICSE.2012.6227139. ISBN 978-1-4673-1067-3.