| Name | Modified | Size | Downloads / Week |
|---|---|---|---|
| fbdoc_1_1_0 | 2026-10-23 | ||
| fbdoc_1_0_0 | 2026-10-23 | ||
| README.md | 2026-11-10 | 7.0 kB | |
| Totals: 3 Items | 7.0 kB | 3 |
fbdoc een FreeBASIC-documentatietool
Met o.a. uitvoor naar| fbdoc | FreeBASIC (.bas, .bi) | text, Markdown, HTML, JSON, Graphviz, Mermaid, aanroepboom |
| msxbasicdoc | MSX-BASIC (ASCII-opgeslagen .BAS) | HTML, optioneel Graphviz |
Beide tools zijn zelf in FreeBASIC geschreven en hebben geen externe bibliotheken nodig.
English summary: see below.
Inhoud van de repository
fbdoc/
fbdoc.bas
inc/
autodoc.bas callgraph.bas declares.bi doccomment.bas
files.bas globals.bi help.bas lang.bas
layout.bas out_graph.bas out_html.bas out_text.bas
parser.bas tokenizer.bas types.bi util.bas
lang/
fbdoc.pot nl.po
examplefreebasic
LICENSE
CHANGELOG.md
README.md
Compileren
Je hebt de FreeBASIC-compiler (fbc) nodig.
cd fbdoc
fbc -lang fblite -s console fbdoc.bas
Werkt op Linux en Windows; het padscheidingsteken wordt bij het compileren gekozen.
Wil je een vertaling gebruiken, zet dan de map lang naast het programma (zie Vertalingen).
fbdoc
Een soort javadoc voor FreeBASIC. fbdoc scant mappen (recursief), leest het commentaar boven elke declaratie en maakt daar documentatie van, inclusief een aanroepgraaf.
Wat het doet
- Documenteert
Sub,Function,Property,Constructor,Destructor,Operator,Type,Union,Enum,Namespace,Const,Dim/Common/Extern,#defineen#macro - Leest commentaar met een apostrof (
'of''),Remen/' ... '/-blokken (ook genest) - Ondersteunt tags:
@param@return@returns@throws@author@since@see@deprecated@brief@note - Ontbreekt commentaar, dan wordt een beschrijving afgeleid uit de naam, de parameters en het returntype (gemarkeerd als auto)
- Bouwt een aanroepgraaf, ook voor aanroepen zonder haakjes (
MijnSub a, b) en procedurepointers (@proc) - Rapporteert documentatiedekking, onopgeloste aanroepen en mogelijk ongebruikte code
- Volgt desgewenst
#include-bestanden om aanroepen op te lossen, zonder die bestanden zelf te documenteren
Commentaar schrijven
'' Telt twee getallen op.
'' Langere uitleg mag op de volgende regels.
'' @param a eerste getal
'' @param b tweede getal
'' @return de som van a en b
'' @since 1.0
Function Som(ByVal a As Integer, ByVal b As Integer) As Integer
Return a + b
End Function
De eerste zin wordt de korte omschrijving, de rest komt in de details.
Gebruik
fbdoc [opties] <pad> [pad2 ...]
| Optie | Betekenis |
|---|---|
-o, --output <bestand> |
uitvoer naar bestand (anders stdout) |
-f, --format <fmt> |
text | md | html | json | dot | mermaid | tree (standaard text) |
-l, --lang <code\|bestand.po> |
taal van alle teksten (standaard en), zie Vertalingen |
-n, --name <naam> |
projectnaam in de kop |
-e, --ext <lijst> |
extensies, kommagescheiden (standaard .bas,.bi) |
-x, --exclude <patroon> |
pad uitsluiten (meerdere keren toegestaan) |
--no-private |
alleen publieke functies |
-R, --no-recursive |
niet recursief scannen |
-G, --no-generate |
geen beschrijvingen genereren |
-u, --undocumented |
alleen elementen zonder commentaar tonen |
-c, --coverage |
dekkingsoverzicht tonen |
--fail-under <pct> |
exitcode 1 bij dekking onder pct (handig in CI) |
--split |
HTML verdeeld over losse pagina's in een map (met -f html) |
--follow |
#include-bestanden meelezen als referentie |
-i, --include <map> |
zoekpad voor #include |
--follow-depth <n> |
hoe diep includes volgen (standaard 2) |
--refs <pad> |
extra code meelezen voor naamresolutie |
--ref-depth <n> |
hoeveel stappen referentiecode in het diagram (standaard 1) |
--extern |
ook onopgeloste aanroepen tonen |
--depth <n> |
maximale diepte van de aanroepboom (standaard 12) |
-q, -v, -d |
stil, uitgebreid, debug |
--log <bestand> |
meldingen ook naar een logbestand |
-h, --help, --version |
hulp en versie |
Voorbeelden
fbdoc -f html -o api.html -n "Mijn project" ./src
fbdoc -f html --split -o docs --follow -i inc ./src
fbdoc -f md -o API.md ./src
fbdoc -u -c --fail-under 60 ./src
fbdoc -f tree -o calls.txt ./src
fbdoc -f dot -o calls.dot ./src && dot -Tsvg calls.dot -o calls.svg
De HTML-uitvoer bevat een zoombaar, versleepbaar aanroepdiagram, een filter in de navigatie en een donkere modus die de systeeminstelling volgt.
Vertalingen
Standaard Engelstalig. Een vertaling is een gettext .po-bestand in de map
lang naast het programma. Met -l kies je de taal:
fbdoc -l nl -f html -o api.html ./src
-l nllaadtlang/nl.ponaast het programma, en anderslang/nl.poin de huidige map-l pad/naar/es.polaadt een.po-bestand op een willekeurige plek- de omgevingsvariabele
FBDOC_LANGzet de standaardtaal - ontbreekt een tekst in de vertaling, dan blijft die Engels
Een Nederlandse vertaling (nl.po) wordt meegeleverd.
Een taal toevoegen
- Kopieer
lang/fbdoc.potnaarlang/<code>.po, bijvoorbeeldlang/es.pooflang/ja.po. - Vul de
msgstr-regels in en zet de taalcode bijLanguage:in de kop. Een programma als Poedit werkt ook. - Sla het bestand op als UTF-8.
%1, %2 en %3 worden door het programma ingevuld; houd ze aan, in elke gewenste volgorde.
Licentie
Copyright © 2026 Marcel "SmartDuck" Beekman
Uitgebracht onder de 3-clause BSD-licentie.
Je mag de tools vrij gebruiken, aanpassen en verspreiden, ook commercieel, zolang de
copyrightvermelding en licentietekst behouden blijven. Zie LICENSE voor de
volledige tekst.
In English
A command-line tool that generate documentation from BASIC source code, written in FreeBASIC with no external dependencies.
fbdoc is a javadoc-style generator for FreeBASIC. It reads the comment above each declaration (', Rem or /' ... '/), supports @param, @return, @see and other tags, generates descriptions where comments are missing, builds a call graph, and reports documentation coverage and possibly unused code. Output formats: text, Markdown, HTML (single page or split), JSON, Graphviz, Mermaid and a call tree. Run fbdoc --help for all options.
English by default. Translations are gettext .po files in a lang
folder next to the program; select one with -l (for example -l nl, which ships with the
tool) or with the FBDOC_LANG environment variable. To add a language,
copy lang/fbdoc.pot to lang/<code>.po, fill in the msgstr
lines and save as UTF-8. Untranslated lines stay in English.
Build:
fbc -lang fblite -s console fbdoc/fbdoc.bas
Released under the 3-clause BSD license, copyright © 2026 Marcel "SmartDuck" Beekman.
See LICENSE.