Funktions Dokumentation

Übersicht

BlitzMax, BlitzMax NG

Beginners-Corner

	Ana Betreff: Funktions Dokumentation	Mi, Apr 06, 2011 1:55 Antworten mit Zitat
Hallihallo, ich hab mich gerade gefragt, ob es eine Möglichkeit gibt, seine Funktionen wirklich gut zu dokumentieren. Eventuell auch so, dass die Hilfe sie erkennt und am schönsten wäre es, wenn sie dann auch noch gehighlightet werden. Gibt es da eine bequeme Lösung, vergleichbar mit JavaDoc's oder ähnlichem? Mir ist aufgefallen das bei den Modulen immer ein paar Rem Zeilen drüberstehen, geht das so einfach? Vielen Dank schon mal Ana
Don't only practice your art, but force your way into its secrets, for it and knowledge can raise human to divine

Ana

Betreff: Funktions Dokumentation

Mi, Apr 06, 2011 1:55
Antworten mit Zitat

Hallihallo,

ich hab mich gerade gefragt, ob es eine Möglichkeit gibt, seine Funktionen wirklich gut zu dokumentieren. Eventuell auch so, dass die Hilfe sie erkennt und am schönsten wäre es, wenn sie dann auch noch gehighlightet werden.

Gibt es da eine bequeme Lösung, vergleichbar mit JavaDoc's oder ähnlichem? Mir ist aufgefallen das bei den Modulen immer ein paar Rem Zeilen drüberstehen, geht das so einfach?

Vielen Dank schon mal

Ana

Don't only practice your art,
but force your way into its secrets,
for it and knowledge
can raise human to divine

	Xeres Moderator	Mi, Apr 06, 2011 2:58 Antworten mit Zitat
Um die Dokumentation zu verwenden, musst du dein Code als Modul einbinden. Um den Funktionsnamen/Konstanten hervor zu heben, reicht das: BlitzMax: [AUSKLAPPEN] [EINKLAPPEN] Rem bbdoc: End Rem Function FunctionsName... Drei Felder können verwendet werden: BlitzMax: [AUSKLAPPEN] [EINKLAPPEN] Rem bbdoc: "Description" returns: "Returns" about: "Information" End Rem Function FunctionsName... Um ein Beispiel ein zu binden, muss man im Unterordner "doc" des Moduls eine Datei "FunctionsName.bmx" anlegen (glaube, case senitiv). @ Schreibt ein Wort Fett, % Kursiv, # Verlinkt auf einen anderen Befehl in den Docs. Man kann Html Code verwenden um Zeilenumbrüche oder Tabellen zu generieren oder Bilder einbinden. Fügt man eine "intro.bbdoc" (textdatei) im Unterordner "doc" ein, kann man den Kopf der Dokumentation gestalten, ebenfalls mit bekannten Html-Befehlen. Das ist das wichtigste, was ich beim Dokumentieren von Ava's Mod im Kopf behalten habe. Wenn man sich Mühe gibt, kann man mit bbdocs ein Modul exzellent dokumentieren
Win10 Prof.(x64)/Ubuntu 16.04\|CPU 4x3Ghz (Intel i5-4590S)\|RAM 8 GB\|GeForce GTX 960 Wie man Fragen richtig stellt \|\| "Es geht nicht" \|\| Video-Tutorial: Sinus & Cosinus THERE IS NO FAIR. THERE IS NO JUSTICE. THERE IS JUST ME. (Death, Discworld)

Xeres

Moderator

Mi, Apr 06, 2011 2:58
Antworten mit Zitat

Um die Dokumentation zu verwenden, musst du dein Code als Modul einbinden.

Um den Funktionsnamen/Konstanten hervor zu heben, reicht das:
BlitzMax: [AUSKLAPPEN]

Rem
bbdoc:
End Rem
Function FunctionsName...

Drei Felder können verwendet werden:
BlitzMax: [AUSKLAPPEN]

Rem
bbdoc: "Description"
returns: "Returns"
about: "Information"
End Rem
Function FunctionsName...

Um ein Beispiel ein zu binden, muss man im Unterordner "doc" des Moduls eine Datei "FunctionsName.bmx" anlegen (glaube, case senitiv).
@ Schreibt ein Wort Fett, % Kursiv, # Verlinkt auf einen anderen Befehl in den Docs.
Man kann Html Code verwenden um Zeilenumbrüche oder Tabellen zu generieren oder Bilder einbinden.
Fügt man eine "intro.bbdoc" (textdatei) im Unterordner "doc" ein, kann man den Kopf der Dokumentation gestalten, ebenfalls mit bekannten Html-Befehlen.

Das ist das wichtigste, was ich beim Dokumentieren von Ava's Mod im Kopf behalten habe.
Wenn man sich Mühe gibt, kann man mit bbdocs ein Modul exzellent dokumentieren Wink

Win10 Prof.(x64)/Ubuntu 16.04|CPU 4x3Ghz (Intel i5-4590S)|RAM 8 GB|GeForce GTX 960
Wie man Fragen richtig stellt || "Es geht nicht" || Video-Tutorial: Sinus & Cosinus
THERE IS NO FAIR. THERE IS NO JUSTICE. THERE IS JUST ME. (Death, Discworld)

	Ana	Mi, Apr 06, 2011 3:11 Antworten mit Zitat
Achso, schade. Meinen Code, ohne ihn gleich als Modul machen zu müssen, kann ich dann also nicht einfach direkt gut dokumentieren, mal abgesehen von Strichkunstwerken in Kommentaren? Und wie mach ich etwas zu einem Modul?
Don't only practice your art, but force your way into its secrets, for it and knowledge can raise human to divine

Ana

Mi, Apr 06, 2011 3:11
Antworten mit Zitat

Achso, schade. Meinen Code, ohne ihn gleich als Modul machen zu müssen, kann ich dann also nicht einfach direkt gut dokumentieren, mal abgesehen von Strichkunstwerken in Kommentaren?

Und wie mach ich etwas zu einem Modul?

Don't only practice your art,
but force your way into its secrets,
for it and knowledge
can raise human to divine

	Xeres Moderator	Mi, Apr 06, 2011 3:24 Antworten mit Zitat
Hier ist 'ne tolle Sammlung zum Thema Wie erstelle ich ein eigenes Modul...
Win10 Prof.(x64)/Ubuntu 16.04\|CPU 4x3Ghz (Intel i5-4590S)\|RAM 8 GB\|GeForce GTX 960 Wie man Fragen richtig stellt \|\| "Es geht nicht" \|\| Video-Tutorial: Sinus & Cosinus THERE IS NO FAIR. THERE IS NO JUSTICE. THERE IS JUST ME. (Death, Discworld)

Xeres

Moderator

Mi, Apr 06, 2011 3:24
Antworten mit Zitat

Hier ist 'ne tolle Sammlung zum Thema Wink

Wie erstelle ich ein eigenes Modul...

	Ana	Mi, Apr 06, 2011 14:30 Antworten mit Zitat
Danke Xeres, auch wenn es sich nicht so wirklich dafür eignet jede hinz und kunz Funktion in ein Modul zupacken nehme ich an. Schade das es nicht klappt wie ich mir das vorstelle
Don't only practice your art, but force your way into its secrets, for it and knowledge can raise human to divine

Ana

Mi, Apr 06, 2011 14:30
Antworten mit Zitat

Danke Xeres, auch wenn es sich nicht so wirklich dafür eignet jede hinz und kunz Funktion in ein Modul zupacken nehme ich an.

Schade das es nicht klappt wie ich mir das vorstelle Very Happy

Don't only practice your art,
but force your way into its secrets,
for it and knowledge
can raise human to divine

	AnniXa	Do, Apr 07, 2011 3:36 Antworten mit Zitat
Mit der ide "Blide" funktioniert das denke ich so wie du das hoffst, jedes includierte file wird dabei benutzt fürs highlight, die autovervollständigung, und diese tooltipdinger die einem anzeigen welche parameter eine func braucht, in dessen klammer man sich gerade befindet. und der bbdoc text wird auch in diesem tooltip ding angezeigt.
\|moonForge\| Ich bin Pokémon Meisterin seit 1998!

AnniXa

Do, Apr 07, 2011 3:36
Antworten mit Zitat

Mit der ide "Blide" funktioniert das denke ich so wie du das hoffst, jedes includierte file wird dabei benutzt fürs highlight, die autovervollständigung, und diese tooltipdinger die einem anzeigen welche parameter eine func braucht, in dessen klammer man sich gerade befindet.
und der bbdoc text wird auch in diesem tooltip ding angezeigt.

|moonForge|
Ich bin Pokémon Meisterin seit 1998!

	Holzchopf Meisterpacker	Do, Apr 07, 2011 9:23 Antworten mit Zitat
Du könntest auch einfach ein "leeres" Modul machen, in dem du die gewünschten Funktionsnamen und Beschreibungen wie folgt definierst: BlitzMax: [AUSKLAPPEN] [EINKLAPPEN] Rem bbdoc: Kurzbeschreibung deiner Funktion about: Etwas ausführlichere Beschreibung (optional) returns: Was auch immer, hilfreich ist meistens der Verwendungszweck, der Datentyp steht ja i.d.R. schon in der Schnellhilfe (unten in der Statusleiste) (auch optional) parameter: Beschreibung der Parameter (optional, wird afaik 1x je Parameter verwendet) keyword: "NameDeinerFunktion" End Rem Und dann einfach die Dokumentation neu "builden". Natürlich wird dann in der Hilfe nicht der richtige Pfad zur Datei, wo die Funktion definiert wird, angezeigt, sondern der Pfad zum Hilfs-Modul. mfG Holzchopf
Erledige alles Schritt um Schritt - erledige alles. - Holzchopf CC BY ♫ BinaryBorn - Yogurt ♫ (31.10.2018) Im Kopf da knackt's und knistert's sturm - 's ist kein Gedanke, nur ein Wurm

Holzchopf

Meisterpacker

Do, Apr 07, 2011 9:23
Antworten mit Zitat

Du könntest auch einfach ein "leeres" Modul machen, in dem du die gewünschten Funktionsnamen und Beschreibungen wie folgt definierst:
BlitzMax: [AUSKLAPPEN]

Rem
bbdoc: Kurzbeschreibung deiner Funktion
about: Etwas ausführlichere Beschreibung (optional)
returns: Was auch immer, hilfreich ist meistens der Verwendungszweck, der Datentyp steht ja i.d.R. schon in der Schnellhilfe (unten in der Statusleiste) (auch optional)
parameter: Beschreibung der Parameter (optional, wird afaik 1x je Parameter verwendet)
keyword: "NameDeinerFunktion"
End Rem

Und dann einfach die Dokumentation neu "builden". Natürlich wird dann in der Hilfe nicht der richtige Pfad zur Datei, wo die Funktion definiert wird, angezeigt, sondern der Pfad zum Hilfs-Modul.

mfG
Holzchopf

Erledige alles Schritt um Schritt - erledige alles. - Holzchopf
CC BY ♫ BinaryBorn - Yogurt ♫ (31.10.2018)
Im Kopf da knackt's und knistert's sturm - 's ist kein Gedanke, nur ein Wurm

Übersicht

BlitzMax, BlitzMax NG

Beginners-Corner

Nach Oben

BlitzBasic Portal

Funktions Dokumentation

Ana

Betreff: Funktions Dokumentation

Xeres

Ana

Xeres

Ana

AnniXa

Holzchopf