jaPBdoc

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

Beitrag von remi_meier »

Ich weiss jetzt nicht, wie dus probiert hast, aber Mehrzeiler funktionieren
hier noch wie gehabt:

Code: Alles auswählen

;** test
;* ein_
;* test
Procedure test()
EndProcedure
Etwas anderes ist es, wenn die Beschreibung direkt im Prozedurenkopf
erfolgt, dann geht nur dieser eine Kommentar in die Beschreibung (nur
diese eine Zeile).

Code: Alles auswählen

Procedure test() ;* die beschreibung
;* <- geht nicht, wird dem letzten ;**-Kommentar angefügt
EndProcedure
Übrigens:
Es ist nicht möglich eine Beschreibung 'später' zu ergänzen, sie wird immer
überschrieben (eine Warnung wird in der Konsole ausgegeben!).
Beispiel, was ne Warnung erzeugen sollte:

Code: Alles auswählen

;** test
;* Beschreibung zu Test()
Procedure test() ;* überschreibt die erste Beschreibung
oder

Code: Alles auswählen

Procedure Test() ;* Beschreibung
Endprocedure
;** test
;* überschreibt die erste Beschreibung
Hab ich so gemacht, damit nicht zu viel verknüppelt wird :D

greetz
Remi
Benutzeravatar
bobobo
jaAdmin
Beiträge: 3857
Registriert: 13.09.2004 17:48
Kontaktdaten:

Beitrag von bobobo »

:allright:
‮pb aktuell5.7 - windoof aktuell und sowas von 10
Ich hab Tinnitus im Auge. Ich seh nur Pfeifen.
Benutzeravatar
#NULL
Beiträge: 2235
Registriert: 20.04.2006 09:50

Beitrag von #NULL »

hat noch jemand eine version, oder besteht die möglichkeit den download nochmal möglich zu machen? ich find's bei mir nicht mehr. :cry:
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 »

Tut mir leid, mein Webspace wurde irgendwie gekillt (kA wieso). Du kannst
jaPBdoc im Verzeichnis "Documentation" hier finden:
http://remi.secretly.de/downloads/OpenG ... nux.tar.gz (öffnen mit WinRAR)
(original Zip ist auf einem anderen PC, aber die Exe sollte trotzdem die
aktuellste sein)
Benutzeravatar
#NULL
Beiträge: 2235
Registriert: 20.04.2006 09:50

Beitrag von #NULL »

danke!
die doku/readme wäre dann nochmal irgendwann cool.
my pb stuff..
Bild..jedenfalls war das mal so.
Benutzeravatar
#NULL
Beiträge: 2235
Registriert: 20.04.2006 09:50

Beitrag von #NULL »

gibt es eine syntax für die beschreibung von rückgabewerten, oder pack ich das einfach in die allgemeine beschreibung rein? (so ist es scheinbar in der ogl-datei).
was ich nicht schlecht fände: eine möglichkeit mit nem tag z.b. eine funktion nicht mit zu dokumentieren, so dass sie auch nirgends im html-dokument erwähnt wird / vorkommt.
<edit> ..oder vielleicht einfach ein parameter, um nur elemente aufzunehmen, für die doc-tags angegeben wurden.
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 »

Sry, ne Doku gibts im Download zur Linux-Version:
http://remi.secretly.de/downloads/jaPBDoc.tar.gz

Um gewisse Funktionen nicht zu Dokumentieren, kann man sie durch den
Filter
/notstart
The next parameter is a string. No target starting with this string will be documented.
/onlystart
The next parameter is a string. Only targets starting with this string will be documented.
filtern, z. B. Funktionen mit _ davor ignorieren. Mehr geht im Moment noch
nicht.

Wenn ich's grad nicht vergessen hab, gibt es keine spezielle Doku für
Rückgabewerte. Weiss nicht, ob ich das noch hinzufüge. Bin grad etwas
unter Zeitdruck :roll:
Aber ansonsten wäre es ja OpenSource (und der Code recht ordentlich).

Sry :|
Benutzeravatar
#NULL
Beiträge: 2235
Registriert: 20.04.2006 09:50

Beitrag von #NULL »

ah cool, danke.
würde mir's ja gerne selbst anpassen, nur bräuchte ich den windows source.
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 »

IIRC ist der Code Linux kompatibel gemacht, d. h. er sollte speziell auch unter
Windows laufen. Bin aber grad unfähig es zu testen (ev. muss man ja ein/zwei
Codestellen doch noch CompilerIffen). Wenn's ein Problem gibt, bitte melden!
Benutzeravatar
Thorsten1867
Beiträge: 1359
Registriert: 04.02.2005 15:40
Computerausstattung: [Windows 10 x64] [PB V5.7x]
Wohnort: Kaufbeuren
Kontaktdaten:

Beitrag von Thorsten1867 »

Der Link für die Windowsversion scheint ungültig zu sein.
Download of PureBasic - Module
Download of PureBasic - Programmes

[Windows 11 x64] [PB V6]

Bild
Antworten