Docmods scheint keyword nicht zu mögen

Übersicht

BlitzMax, BlitzMax NG

Beginners-Corner

	Tritium Betreff: Docmods scheint keyword nicht zu mögen	So, Mai 13, 2012 15:05 Antworten mit Zitat
Tach zusammen, mir ist grad aufgefallen, dass DocMods in manchen meiner Module etwas spinnt. Folgende Dokumentation BlitzMax: [AUSKLAPPEN] [EINKLAPPEN] Rem bbdoc: Schließt die Verbindung des Servers zur Pipe returns: True wenn erfolgreich, sonst False about: Führt dazu, dass auch die Klienten nicht mehr auf die Pipe zugreifen können. Diese müssen ihre Verbindung dennoch mittels #DisconnectFromNamedPipe beenden keyword: CloseNamedPipe End Rem Function CloseNamedPipe(pipeName$) ... End Function ...führt dazu, dass in der fertigen Dokumentation zur Funktion das "Information"-Feld mit "beenden keyword: CloseNamedPipe." endet. Alles andere funktioniert, die Funktion wird auch richtig gehighlighted. Allerdings tritt das Problem nur bei manchen Funktionen auf, bei anderen funktioniert alles wie es soll. Der Zeilenumbruch in der Dokumentation scheint nicht das Problem zu sein, auch wenn ich alles in eine Zeile schreibe taucht "keyword: CloseNamedPipe." in der fertigen Dokumentation auf. Auch die Umlaute sind kein Problem. Weiß da jemand Rat (damit meine ich nicht "Benutz HotDocs", das hab ich bereits ausprobiert und es gefällt mir weniger gut)?

Tritium

Betreff: Docmods scheint keyword nicht zu mögen

So, Mai 13, 2012 15:05
Antworten mit Zitat

Tach zusammen,

mir ist grad aufgefallen, dass DocMods in manchen meiner Module etwas spinnt. Folgende Dokumentation
BlitzMax: [AUSKLAPPEN]

Rem
	bbdoc: Schließt die Verbindung des Servers zur Pipe
	returns: True wenn erfolgreich, sonst False
	about: Führt dazu, dass auch die Klienten nicht mehr auf die Pipe zugreifen können. Diese müssen ihre Verbindung
dennoch mittels #DisconnectFromNamedPipe beenden
	keyword: CloseNamedPipe
End Rem
Function CloseNamedPipe(pipeName$)
...
End Function

...führt dazu, dass in der fertigen Dokumentation zur Funktion das "Information"-Feld mit "beenden keyword: CloseNamedPipe." endet. Alles andere funktioniert, die Funktion wird auch richtig gehighlighted.

Allerdings tritt das Problem nur bei manchen Funktionen auf, bei anderen funktioniert alles wie es soll. Der Zeilenumbruch in der Dokumentation scheint nicht das Problem zu sein, auch wenn ich alles in eine Zeile schreibe taucht "keyword: CloseNamedPipe." in der fertigen Dokumentation auf. Auch die Umlaute sind kein Problem.

Weiß da jemand Rat (damit meine ich nicht "Benutz HotDocs", das hab ich bereits ausprobiert und es gefällt mir weniger gut)?

	ZEVS	So, Mai 13, 2012 15:36 Antworten mit Zitat
Das liegt daran, dass der about-Text mehrere Zeilen beinhaltet. Entweder du schreibst keyword davor oder - was mir sinnvoller scheint, zumindest in diesem Falle - du lässt es weg. Was soll es denn da? Es hat den gleichen Namen wie die Funktion und dieser wird ohnehin angezeigt. ZEVS

ZEVS

So, Mai 13, 2012 15:36
Antworten mit Zitat

Das liegt daran, dass der about-Text mehrere Zeilen beinhaltet. Entweder du schreibst keyword davor oder - was mir sinnvoller scheint, zumindest in diesem Falle - du lässt es weg. Was soll es denn da? Es hat den gleichen Namen wie die Funktion und dieser wird ohnehin angezeigt.

ZEVS

	Tritium	So, Mai 13, 2012 20:32 Antworten mit Zitat
Nein, daran liegt es nicht, in anderen meiner Module sind die Beschreibungen auch mehrere Zeilen lang und das ist dort kein Problem. Wenn ich keyword davor schreibe verschwindet der Information-Teil bzw. alles, was auf keyword folgt, in der fertigen Dokumentation, das hab ich schon ausprobiert. Der Sinn ist, dass keyword dazu führt, dass der Funktionsname überall gehighlighted wird, die IDE wandelt den Funktionsnamen also bei Benutzung auch automatisch in die passende Groß-/Kleinschreibung um.

Tritium

So, Mai 13, 2012 20:32
Antworten mit Zitat

Nein, daran liegt es nicht, in anderen meiner Module sind die Beschreibungen auch mehrere Zeilen lang und das ist dort kein Problem. Wenn ich keyword davor schreibe verschwindet der Information-Teil bzw. alles, was auf keyword folgt, in der fertigen Dokumentation, das hab ich schon ausprobiert. Der Sinn ist, dass keyword dazu führt, dass der Funktionsname überall gehighlighted wird, die IDE wandelt den Funktionsnamen also bei Benutzung auch automatisch in die passende Groß-/Kleinschreibung um.

	DaysShadow	So, Mai 13, 2012 21:57 Antworten mit Zitat
Das tut es auch ohne extra keyword. Schreib doch mal "rUnTimeeRRor" in deine IDE und mach ein Leerzeichen dahinter, das wird automatisch korrigiert und dieser Befehl hat nicht extra keyword aufgeführt. Funktionen haben quasi auto-keyword, wenn sie dokumentiert sind Zu finden in brl.blitz und wohl bei jeder anderen Funktion/Methode von BRL.
Blessed is the mind too small for doubt

DaysShadow

So, Mai 13, 2012 21:57
Antworten mit Zitat

Das tut es auch ohne extra keyword.

Schreib doch mal "rUnTimeeRRor" in deine IDE und mach ein Leerzeichen dahinter, das wird automatisch korrigiert und dieser Befehl hat nicht extra keyword aufgeführt.
Funktionen haben quasi auto-keyword, wenn sie dokumentiert sind

Zu finden in brl.blitz und wohl bei jeder anderen Funktion/Methode von BRL.

Blessed is the mind too small for doubt

	ProfJake ehemals "DTC" / "Fabian Niemann"	So, Mai 13, 2012 23:57 Antworten mit Zitat
Also ich nehme jetzt einfach mal an, dass du die MaxIDE benutzt. Bei der werden alle richtig dokumentierten Funktionen, Methoden, Klassen, Konstanten und Variablen automatisch gehighlightet und richtig groß/klein geschrieben. Die dazugehörigen Optionen in der IDE heißen "Auto Capitalize" und "Syntax Highlighting", zu finden unter File > IDE Options. Hoffe, ich habe dein Problem richtig verstanden. P.S Bei "keyword" müssen Anführungszeichen drumrum.

ProfJake

ehemals "DTC" / "Fabian Niemann"

So, Mai 13, 2012 23:57
Antworten mit Zitat

Also ich nehme jetzt einfach mal an, dass du die MaxIDE benutzt.
Bei der werden alle richtig dokumentierten Funktionen, Methoden,
Klassen, Konstanten und Variablen automatisch gehighlightet und
richtig groß/klein geschrieben.

Die dazugehörigen Optionen in der IDE heißen "Auto Capitalize" und
"Syntax Highlighting", zu finden unter File > IDE Options.

Hoffe, ich habe dein Problem richtig verstanden.

P.S Bei "keyword" müssen Anführungszeichen drumrum.

	Tritium	Mo, Mai 14, 2012 10:50 Antworten mit Zitat
DaysShadow hat Folgendes geschrieben: Funktionen haben quasi auto-keyword, wenn sie dokumentiert sind Oh, das wusste ich nicht, ich dachte immer, dass keyword dazu dient Dann kann ich mir keyword ja sparen. Nur, wozu genau dient keyword dann? ProfJake hat Folgendes geschrieben: P.S Bei "keyword" müssen Anführungszeichen drumrum. Was genau meinst Du?

Tritium

Mo, Mai 14, 2012 10:50
Antworten mit Zitat

DaysShadow hat Folgendes geschrieben:

Funktionen haben quasi auto-keyword, wenn sie dokumentiert sind

Oh, das wusste ich nicht, ich dachte immer, dass keyword dazu dient Idea

Dann kann ich mir keyword ja sparen. Nur, wozu genau dient keyword dann?

ProfJake hat Folgendes geschrieben:

P.S Bei "keyword" müssen Anführungszeichen drumrum.

Was genau meinst Du?

	ProfJake ehemals "DTC" / "Fabian Niemann"	Mo, Mai 14, 2012 11:50 Antworten mit Zitat
Wenn du mal in den Code von blitz.mod schaust, dann steht da bei der Dokumentation das jeweilige Keyword immer in Anführungszeichen. BlitzMax: [AUSKLAPPEN] [EINKLAPPEN] Rem bbdoc: Come on, use SuperStrict please keyword: "Strict" End Rem Oder so ähnlich, habe gerade kein BlitzMax zur Verfügung hier.

ProfJake

ehemals "DTC" / "Fabian Niemann"

Mo, Mai 14, 2012 11:50
Antworten mit Zitat

Wenn du mal in den Code von blitz.mod schaust, dann steht da bei
der Dokumentation das jeweilige Keyword immer in Anführungszeichen.
BlitzMax: [AUSKLAPPEN]

Rem
bbdoc: Come on, use SuperStrict please
keyword: "Strict"
End Rem

Oder so ähnlich, habe gerade kein BlitzMax zur Verfügung hier.

Übersicht

BlitzMax, BlitzMax NG

Beginners-Corner

Nach Oben

BlitzBasic Portal

Docmods scheint keyword nicht zu mögen

Tritium

Betreff: Docmods scheint keyword nicht zu mögen

ZEVS

Tritium

DaysShadow

ProfJake

Tritium

ProfJake