Generátor dokumentace - Documentation generator

A generátor dokumentace je programovací nástroj který generuje softwarová dokumentace určeno pro programátory (Dokumentace API ) nebo koncoví uživatelé (koncový uživatel průvodce) nebo obojí ze sady zdrojový kód soubory a v některých případech binární soubory. Některé generátory, jako např Doxygen nebo Javadoc, použijte speciální komentáře řídit generaci.

Druhy generace

Generování dokumentů lze rozdělit do několika typů:

  • Generování šarží (obecná technika)
  • Korespondence textových bloků (dokumenty vytvořené na základě předdefinovaných textových bloků)
  • Formuláře (formuláře pro webové stránky)
  • Syntéza dokumentace:
    • Dokumentaci lze odvodit z kódu[1]
    • Dokumentaci lze odvodit ze stop po provedení[2]
    • Dokumentaci lze odvodit z e-mailových konferencí[3]

Nějaký integrovaná vývojová prostředí poskytovat interaktivní přístup k dokumentaci, metadata kódu atd.

Reference

  1. ^ Bruch, Marcel; Mezini, Mira; Monperrus, Martin (2010). „Směrnice o těžbě podtříd za účelem zlepšení opětovného použití rámce“. 7. pracovní konference IEEE 2010 o úložištích těžebního softwaru (MSR 2010). 141–150. doi:10.1109 / MSR.2010.5463347. ISBN  978-1-4244-6802-7.
  2. ^ Zhang, Sai; Zhang, Cheng; Ernst, Michael (2011). „Automatická dokumentace vyvozující vysvětlení neúspěšných testů“ (PDF). 26. mezinárodní konference IEEE / ACM 2011 o automatizovaném softwarovém inženýrství (ASE 2011). str. 63–72. doi:10.1109 / ASE.2011.6100145. ISBN  978-1-4577-1639-3.
  3. ^ Slepice, Stefan; Monperrus, Martin; Mezini, Mira (2012). „Poloautomatické extrahování často kladených otázek ke zlepšení přístupnosti znalostí o vývoji softwaru“. 34. 34. mezinárodní konference o softwarovém inženýrství (ICSE). 793–803. arXiv:1203.5188. doi:10.1109 / ICSE.2012.6227139. ISBN  978-1-4673-1067-3.

Viz také