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 Dokumentasjon kan utledes basert på spor fra kjøring Dokumentasjon kan utledes fra epostlister

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

Se også Litterat programmering Integrert utviklingsmiljø

Referanser

Kategori:Programvareutvikling