Generator dokumentacji - Documentation generator
Generator dokumentacji jest narzędziem programowania , który generuje dokumentacji oprogramowania przeznaczonego dla programistów ( dokumentacja API ) lub użytkowników końcowych ( end-user Guide), lub zarówno z zestawu kodu źródłowego plików, a w niektórych przypadkach, pliki binarne . Niektóre generatory, takie jak Javadoc , mogą używać specjalnych komentarzy do sterowania generowaniem. Przykładem generatora, który może wykorzystywać wszystkie te metody, jest Doxygen .
Rodzaje pokoleń
Generowanie dokumentów można podzielić na kilka typów:
- Generowanie partii (technika ogólna)
- Korespondencja bloków tekstowych (dokumenty tworzone na podstawie predefiniowanych bloków tekstowych)
- Formularze (formularze do witryn internetowych)
- Synteza dokumentacji:
- Dokumentację można wywnioskować z kodu
- Dokumentację można wywnioskować ze śladów wykonania
- Dokumentację można wywnioskować z list mailingowych
Niektóre zintegrowane środowiska programistyczne zapewniają interaktywny dostęp do dokumentacji, metadanych kodu itp.
Bibliografia
Zobacz też
- Porównanie generatorów dokumentacji
- Procesor szablonów
- Statyczna analiza kodu
- Programowanie literackie
- Zintegrowane środowisko programistyczne
Ten artykuł dotyczący określonego typu oprogramowania jest kodem pośrednim . Możesz pomóc Wikipedii, rozbudowując ją . |