jaPBdoc

Anwendungen, Tools, Userlibs und anderes nützliches.
Benutzeravatar
remi_meier
Beiträge: 1078
Registriert: 29.08.2004 20:11
Wohnort: Schweiz

jaPBdoc

Beitrag von remi_meier »

Wer javadoc kennt und seine Funktionen zu schätzen gelernt hat, der wird
auch dieses kleine Tool lieben (hoff ich zumindest :D )!
Dieses Tool parst den Quellcode einer Datei und erzeugt daraus eine Doku-
mentation, d. h. v. a. aus den speziellen Kommentaren der Datei. Doku-
mentiert werden (vorerst) globale Variablen, Funktionen und inkludierte
Files.
Ein spezieller Kommentar schaut wie folgt aus:

Code: Alles auswählen

;** functionname
;* irgendwelchedokumentation
;* wirdhinterdieoberezeileangefügt

oder für globale Variablen (bzw. LLs und Arrays):

;** g namedervariable
;* wie oben
Die Kommentare werden momentan einfach als HTML in die Datei eingefügt,
das kann Probleme verursachen, aber auch helfen (Tags von HTML möglich).
Bei genügend Interesse wird das Tool weiter entwickelt.

Naja, testet einfach mal mit der .BAT im Zip, dabei wird der Source von
jaPBdoc verarbeitet.

http://mypage.bluewin.ch/remimeier/zip/japbdoc.zip

Viel Spass
Remi
Benutzeravatar
remi_meier
Beiträge: 1078
Registriert: 29.08.2004 20:11
Wohnort: Schweiz

Beitrag von remi_meier »

Neue Version:
- "Inhaltsverzeichnis" hinzugefügt
- Bei Funktionsbeschreibungen wird jetzt in der Tabelle nur noch der Teil
der Beschreibung bis zum ersten Punkt angezeigt, der Rest kommt weiter
unten (verlinkt).
- Parameter können nun separat beschrieben werden, einfach beim ;**-
Kommentar noch .param anfügen:

Code: Alles auswählen

;** funcname.param
;* descr. for param
Das wärs vorerst mal :)
Benutzeravatar
ts-soft
Beiträge: 22292
Registriert: 08.09.2004 00:57
Computerausstattung: Mainboard: MSI 970A-G43
CPU: AMD FX-6300 Six-Core Processor
GraKa: GeForce GTX 750 Ti, 2 GB
Memory: 16 GB DDR3-1600 - Dual Channel
Wohnort: Berlin

Beitrag von ts-soft »

Sehr gute Idee :allright:

Erweiterungsvorschlag:
Kommentare am Ende der Zeile auswerten, vor allem bei Strukturen usw.
Beispiel:

Code: Alles auswählen

;** structure bla
Structure bla
  first.l ;* the first structureelement
  last.l  ;* the last structureelement
EndSelect
wobei der Feldname autom. eingefügt wird.
PureBasic 5.73 LTS | SpiderBasic 2.30 | Windows 10 Pro (x64) | Linux Mint 20.1 (x64)
Nutella hat nur sehr wenig Vitamine. Deswegen muss man davon relativ viel essen.
Bild
Benutzeravatar
#NULL
Beiträge: 2235
Registriert: 20.04.2006 09:50

Beitrag von #NULL »

SPITZE :allright:
my pb stuff..
Bild..jedenfalls war das mal so.
Benutzeravatar
remi_meier
Beiträge: 1078
Registriert: 29.08.2004 20:11
Wohnort: Schweiz

Beitrag von remi_meier »

Danke

@ts-soft: Gute Idee -> eingebaut

Update:
- Auch Strukturen und Interfaces werden dokumentiert, hier kann der
Kommentar auch hinter die Elemente der Struktur/Interface gesetzt werden.
Der ;**-Kommentar muss dabei mit "s " oder "i " beginnen! Einfach
jaPBdoc.pb anschauen <)
- Abkürzung von Parameterangaben (oder auch Elemente von Strukturen):

Code: Alles auswählen

;** s TEST
;** .elem1
;* desc for elem1
;** s .elem2
;* desc for elem2 ("s " is optional here!)

;** function.param1
;* param1 is cool
;** .param2
;* param2 is better ;)
- die Funktionen werden nun sortiert in der Tabelle eingefügt.
ich glaub das wars :)
Benutzeravatar
ts-soft
Beiträge: 22292
Registriert: 08.09.2004 00:57
Computerausstattung: Mainboard: MSI 970A-G43
CPU: AMD FX-6300 Six-Core Processor
GraKa: GeForce GTX 750 Ti, 2 GB
Memory: 16 GB DDR3-1600 - Dual Channel
Wohnort: Berlin

Beitrag von ts-soft »

Sehr gut, sehr nützlich
remi_meier hat geschrieben: ich glaub das wars :)
Konstanten und vor allen Enumerationen :roll:
PureBasic 5.73 LTS | SpiderBasic 2.30 | Windows 10 Pro (x64) | Linux Mint 20.1 (x64)
Nutella hat nur sehr wenig Vitamine. Deswegen muss man davon relativ viel essen.
Bild
Benutzeravatar
remi_meier
Beiträge: 1078
Registriert: 29.08.2004 20:11
Wohnort: Schweiz

Beitrag von remi_meier »

Das wars vorerst :D

Update:
- Makros werden unterstützt (wie Funktionen)
- Konstanten auch (mit oder ohne 'c ' bei ;**)
- Etwas Kosmetik

Sind Konstanten und Enumerationen so ok?
Benutzeravatar
ts-soft
Beiträge: 22292
Registriert: 08.09.2004 00:57
Computerausstattung: Mainboard: MSI 970A-G43
CPU: AMD FX-6300 Six-Core Processor
GraKa: GeForce GTX 750 Ti, 2 GB
Memory: 16 GB DDR3-1600 - Dual Channel
Wohnort: Berlin

Beitrag von ts-soft »

>> Sind Konstanten und Enumerationen so ok?
Ja :D , gefällt mir :allright:
PureBasic 5.73 LTS | SpiderBasic 2.30 | Windows 10 Pro (x64) | Linux Mint 20.1 (x64)
Nutella hat nur sehr wenig Vitamine. Deswegen muss man davon relativ viel essen.
Bild
Benutzeravatar
remi_meier
Beiträge: 1078
Registriert: 29.08.2004 20:11
Wohnort: Schweiz

Beitrag von remi_meier »

Toll :)

Noch ein kleines Update:
- Es kann ein rudimentärer Filter als Parameter dem Programm übergeben
werden, näheres dazu wenn man die .BAT ausgeführt hat und dort die
Hilfe liest (ich weiss, noch etwas wenig..)
- Strukturen-Felder und Prozeduren-Parameter werden nun sortiert dar-
gestellt
- Wenn man als letztes Zeichen eines Kommentars ein _ schreibt, wird
ein Zeilenumbruch eingefügt.
Benutzeravatar
remi_meier
Beiträge: 1078
Registriert: 29.08.2004 20:11
Wohnort: Schweiz

Beitrag von remi_meier »

Noch etwas Kleines, das mir beim Arbeiten mühsam vorkam, behoben:
Man kann nun eine Einzeilerdoku zu allem schreiben:
;** funcname: Doku zur Funktion
;* wird hier fortgesetzt
das mit dem ':' geht natürlich für alles nach einem ;**-Kommentar.
Antworten