Aktuelle Zeit: 21.09.2018 23:03

Alle Zeiten sind UTC + 1 Stunde [ Sommerzeit ]




Ein neues Thema erstellen Auf das Thema antworten  [ 47 Beiträge ]  Gehe zu Seite 1, 2, 3, 4, 5  Nächste
Autor Nachricht
 Betreff des Beitrags: jaPBdoc
BeitragVerfasst: 07.07.2006 20:12 
Offline
Benutzeravatar

Registriert: 29.08.2004 20:11
Wohnort: Schweiz
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:
;** 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


Nach oben
 Profil  
Mit Zitat antworten  
 Betreff des Beitrags:
BeitragVerfasst: 07.07.2006 22:11 
Offline
Benutzeravatar

Registriert: 29.08.2004 20:11
Wohnort: Schweiz
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:
;** funcname.param
;* descr. for param


Das wärs vorerst mal :)


Nach oben
 Profil  
Mit Zitat antworten  
 Betreff des Beitrags:
BeitragVerfasst: 07.07.2006 22:17 
Offline
Benutzeravatar

Registriert: 08.09.2004 00:57
Wohnort: Berlin
Sehr gute Idee :allright:

Erweiterungsvorschlag:
Kommentare am Ende der Zeile auswerten, vor allem bei Strukturen usw.
Beispiel:
Code:
;** structure bla
Structure bla
  first.l ;* the first structureelement
  last.l  ;* the last structureelement
EndSelect

wobei der Feldname autom. eingefügt wird.

_________________
PureBasic 5.70 | SpiderBasic 2.10 | Windows 10 Pro (x64) | Linux Mint 19.0 (x64)
"Ich möchte gerne die Welt verändern, doch Gott gibt den Quellcode nicht frei."
Bild


Nach oben
 Profil  
Mit Zitat antworten  
 Betreff des Beitrags:
BeitragVerfasst: 07.07.2006 22:18 
Offline
Benutzeravatar

Registriert: 20.04.2006 09:50
SPITZE :allright:

_________________
my pb stuff..
Bild..jedenfalls war das mal so.


Nach oben
 Profil  
Mit Zitat antworten  
 Betreff des Beitrags:
BeitragVerfasst: 08.07.2006 11:34 
Offline
Benutzeravatar

Registriert: 29.08.2004 20:11
Wohnort: Schweiz
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:
;** 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 :)


Nach oben
 Profil  
Mit Zitat antworten  
 Betreff des Beitrags:
BeitragVerfasst: 08.07.2006 15:10 
Offline
Benutzeravatar

Registriert: 08.09.2004 00:57
Wohnort: Berlin
Sehr gut, sehr nützlich
remi_meier hat geschrieben:
ich glaub das wars :)

Konstanten und vor allen Enumerationen :roll:

_________________
PureBasic 5.70 | SpiderBasic 2.10 | Windows 10 Pro (x64) | Linux Mint 19.0 (x64)
"Ich möchte gerne die Welt verändern, doch Gott gibt den Quellcode nicht frei."
Bild


Nach oben
 Profil  
Mit Zitat antworten  
 Betreff des Beitrags:
BeitragVerfasst: 08.07.2006 16:39 
Offline
Benutzeravatar

Registriert: 29.08.2004 20:11
Wohnort: Schweiz
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?


Nach oben
 Profil  
Mit Zitat antworten  
 Betreff des Beitrags:
BeitragVerfasst: 08.07.2006 16:52 
Offline
Benutzeravatar

Registriert: 08.09.2004 00:57
Wohnort: Berlin
>> Sind Konstanten und Enumerationen so ok?
Ja :D , gefällt mir :allright:

_________________
PureBasic 5.70 | SpiderBasic 2.10 | Windows 10 Pro (x64) | Linux Mint 19.0 (x64)
"Ich möchte gerne die Welt verändern, doch Gott gibt den Quellcode nicht frei."
Bild


Nach oben
 Profil  
Mit Zitat antworten  
 Betreff des Beitrags:
BeitragVerfasst: 08.07.2006 17:51 
Offline
Benutzeravatar

Registriert: 29.08.2004 20:11
Wohnort: Schweiz
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.


Nach oben
 Profil  
Mit Zitat antworten  
 Betreff des Beitrags:
BeitragVerfasst: 08.07.2006 20:33 
Offline
Benutzeravatar

Registriert: 29.08.2004 20:11
Wohnort: Schweiz
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.


Nach oben
 Profil  
Mit Zitat antworten  
Beiträge der letzten Zeit anzeigen:  Sortiere nach  
Ein neues Thema erstellen Auf das Thema antworten  [ 47 Beiträge ]  Gehe zu Seite 1, 2, 3, 4, 5  Nächste

Alle Zeiten sind UTC + 1 Stunde [ Sommerzeit ]


Wer ist online?

Mitglieder in diesem Forum: 0 Mitglieder und 3 Gäste


Sie dürfen keine neuen Themen in diesem Forum erstellen.
Sie dürfen keine Antworten zu Themen in diesem Forum erstellen.
Sie dürfen Ihre Beiträge in diesem Forum nicht ändern.
Sie dürfen Ihre Beiträge in diesem Forum nicht löschen.

Suche nach:
Gehe zu:  

 


Powered by phpBB © 2008 phpBB Group | Deutsche Übersetzung durch phpBB.de
subSilver+ theme by Canver Software, sponsor Sanal Modifiye