Dokumentasjonsgenerator

En dokumentasjonsgenerator er et programmeringsverktøy som genererer programvaredokumentasjon beregnet for programmerere (for eksempel API-dokumentasjon) eller sluttbrukere (sluttbrukerguide), eller begge deler, basert på en mengde av kildekodefiler, og i noen tilfeller binærfiler. Noen generatorer, som for eksempel Javadoc, kan bruke spesielle kommentarer for å kjøre genereringen. Doxygen er et eksempel på en generator som kan bruke alle disse metodene.

Typer generering

Dokumentgenerering kan deles i flere typer:

Batch-generering (generisk teknikk)
Tekstblokk-korrespondanse (dokumenter opprettet basert på forhåndsdefinerte tekstblokker)
Skjemaer (skjemaer for nettsteder)
Dokumentasjon-syntese:
- Dokumentasjon kan utledes fra kode^[1]
- Dokumentasjon kan utledes basert på spor fra kjøring^[2]
- Dokumentasjon kan utledes fra epostlister^[3]

Noen integrerte utviklingsmiljøer gir interaktiv tilgang til dokumentasjon, kode metadata, med mer.

Se også

Referanser

^ Bruch, Marcel; Mezini, Mira; Monperrus, Martin. «Mining subclassing directives to improve framework reuse». 2010 7th IEEE Working Conference on Mining Software Repositories (MSR 2010). ISBN 978-1-4244-6802-7. doi:10.1109/MSR.2010.5463347.
^ Zhang, Sai; Zhang, Cheng; Ernst, Michael (2011). «Automated documentation inference to explain failed tests» (PDF). 2011 26th IEEE/ACM International Conference on Automated Software Engineering (ASE 2011). ISBN 978-1-4577-1639-3. doi:10.1109/ASE.2011.6100145.
^ Hens, Stefan; Monperrus, Martin; Mezini, Mira. «Semi-automatically extracting FAQs to improve accessibility of software development knowledge». 2012 34th International Conference on Software Engineering (ICSE). ISBN 978-1-4673-1067-3. arXiv:1203.5188 . doi:10.1109/ICSE.2012.6227139.

[BruchMezini2010-1] Bruch, Marcel; Mezini, Mira; Monperrus, Martin. «Mining subclassing directives to improve framework reuse». 2010 7th IEEE Working Conference on Mining Software Repositories (MSR 2010). ISBN 978-1-4244-6802-7. doi:10.1109/MSR.2010.5463347.

[2] Zhang, Sai; Zhang, Cheng; Ernst, Michael (2011). «Automated documentation inference to explain failed tests» (PDF). 2011 26th IEEE/ACM International Conference on Automated Software Engineering (ASE 2011). ISBN 978-1-4577-1639-3. doi:10.1109/ASE.2011.6100145.

[HensMonperrus2012-3] Hens, Stefan; Monperrus, Martin; Mezini, Mira. «Semi-automatically extracting FAQs to improve accessibility of software development knowledge». 2012 34th International Conference on Software Engineering (ICSE). ISBN 978-1-4673-1067-3. arXiv:1203.5188 . doi:10.1109/ICSE.2012.6227139.

[1]

[2]

[3]