Wat is het?
Een kleine commandline-tool die documentatie maakt uit FreeBASIC-broncode
(.bas en .bi). fbdoc is zelf in FreeBASIC geschreven en heeft
geen extra bibliotheken nodig.
Uitvoer: text, Markdown, HTML, JSON, Graphviz, Mermaid en een aanroepboom.
Nieuw in versie 1.1.0
fbdoc is nu standaard Engelstalig en kan worden vertaald. Een Nederlandse
vertaling wordt meegeleverd; gebruik -l nl voor de Nederlandse uitvoer.
Zie Vertalingen.
- Alle teksten zijn vertaalbaar: meldingen, hulptekst en de uitvoer zelf
- Vertalingen zijn gewone
.po-bestanden (gettext), te bewerken met bijvoorbeeld Poedit
Wat het doet
Een soort javadoc voor FreeBASIC. fbdoc leest het commentaar boven elke
declaratie, herkent tags als @param, @return en
@see, en maakt er nette documentatie van. Ontbreekt het commentaar,
dan bedenkt fbdoc een beschrijving op basis van de naam en de parameters.
- Aanroepgraaf, ook van aanroepen zonder haakjes en procedurepointers
- Overzicht van documentatiedekking en mogelijk ongebruikte code
- Interactief, zoombaar diagram in de HTML-uitvoer
- Kan
#include-bestanden volgen om aanroepen op te lossen
'' Telt twee getallen op. '' @param a eerste getal '' @param b tweede getal '' @return de som Function Som(ByVal a As Integer, ByVal b As Integer) As Integer
Documentatie in het Nederlands genereren:
./fbdoc -l nl -f html -o api.html -n "Mijn project" api.bas
Vertalingen
fbdoc is standaard Engelstalig. Een vertaling is een .po-bestand
in de map lang naast het programma. Met -l kies je de taal:
| Zo | Betekenis |
|---|---|
-l nl | laadt lang/nl.po naast het programma (of in de huidige map) |
-l pad/naar/de.po | laadt een .po-bestand op een andere plek |
FBDOC_LANG | omgevingsvariabele voor de standaardtaal |
Ontbreekt een tekst in de vertaling, dan blijft die Engels.
Een taal toevoegen
- Kopieer
lang/fbdoc.potnaarlang/<code>.po, bijvoorbeeldlang/de.po. - Vul de
msgstr-regels in en zet de taalcode bijLanguage:. - Sla het bestand op als UTF-8.
Nieuwe vertalingen zijn welkom via SourceForge.
Compileren
Installeer de FreeBASIC-compiler en voer uit:
fbc -lang fblite -s console fbdoc.bas
Zet de map lang naast het programma als je een vertaling wilt gebruiken.
De broncode, de volledige handleiding (README) en de wijzigingen (CHANGELOG) staan op SourceForge.
Downloaden
| fbdoc 1.1.0 | ||
|---|---|---|
| Windows | fbdoc_win64_1.1.0.zip | 251 KB |
| Linux | fbdoc_linux64_1.1.0.zip | 159 KB |