Documenteren van software is altijd een gevoelig onderwerp.
Goede documentatie is essentieel en behoort onderdeel te zijn van software development, maar niemand vind het leuk of de documentatie is snel verouderd en achterhaald.
Binnen de ontwikkelomgeving Adelia Studio is daar een mooie tool voor bijgekomen: AdeliaDoc.
Blijf altijd up-to-date met technische documentatie
AdeliaDoc is een tool om technische documentatie te genereren gebaseerd op de 4GL source van de Adelia programma's en de informatie uit de object manager.
De gegenereerde documentatie beschrijft de programma's, public procedures en aanroep parameters van deze gegevens.
Een set met specifieke keywords in de vorm van commentaar kan toegevoegd worden in de 4GL source, zodat de software engineers de inhoud van de gegenereerde documentatie kan aanvullen.
Output
De documentatie kan gegenereerd worden naar een van de volgende formats:
- HTML
- LATEX
- text
- RST
Keywords
De specifieke keywords kunnen alleen in de declaratie paragraaf gebruikt worden, voor de PARAM instructie.
| Keyword | Omschrijving |
|---|---|
| @adeliadoc | Hiermee kan een sectie gelabeled worden om filter regels op de documentatie toe te passen. |
| @description | Omschrijving van de sectie |
| @param | Beschrijving van de parameter |
| @field | Beschrijving van een veld dat in een lijst gebruikt wordt |
| @version | Het versienummer van de sectie |
| @author | De naam van de software engineer |
| @since | Sinds wanneer de versie van deze sectie beschikbaar is |
| @date | Datum van de laatste wijziging |
| @deprecated | Geeft aan dat de sectie niet meer gebruikt kan worden |
| @index | Hiermee wordt de sectie toegevoegd aan de index van de documentatie |
Vanaf ptf05 in Adelia Studio 14 is het gebruik van AdeliaDoc opgenomen.