Seite 8 von 8

Re: Documentation Comment

Verfasst: 14.09.2019 23:09
von Sicro
@SDL:
Im Root-Tag <comment>...</comment> werden keine losen Texte unterstützt.

Re: Documentation Comment

Verfasst: 14.09.2019 23:33
von SDL
Sicro hat geschrieben:@SDL:
Im Root-Tag <comment>...</comment> werden keine losen Texte unterstützt.
:oops:
Also mit ; <summary> </summary> oder ; <param> </param> ok hät ich auch selbst drauf kommen können ; /:-> autsch :coderselixir:

Danke SiCro

Re: Documentation Comment

Verfasst: 14.09.2019 23:57
von Sicro
Machen wir aus dem Bug-Report einfach ein Feature-Request. :wink:
Die Idee finde ich nicht schlecht. :)

Übrigens: Eine Ausgabe der Dokumentation als HTML-Dateien ist in Arbeit.

Re: Documentation Comment

Verfasst: 16.09.2019 14:28
von hjf
Hallo RSBasic,

habe die letzte Version mir angeschaut. Die Last ist nun besser!

Es hat sich aber noch eine andere Sache gezeigt:

Code: Alles auswählen

; -----------------------------------------------------------------------------
;<comment>
;  <summary><b><i><br>Was tut diese Procedure Name()</summary>
;  <param>Parameter1: Beschreibung</param>
;  <param>Parameter2: Beschreibung</param>
;  <param>Parameter3: Beschreibung</param>
;  <return>Beschreibung des Rückgabewertes</return>
;  <example>x = Beispielaufruf()</example>
;</comment>
Procedure.i Name() 

  Protected.i Result


  ProcedureReturn Result

EndProcedure

x = Name(
; -----------------------------------------------------------------------------
;<comment>
;  <summary><b><i><br>Was tut diese Procedure Name2()</summary>
;  <param>Parameter1: Beschreibung</param>
;  <param>Parameter2: Beschreibung</param>
;  <param>Parameter3: Beschreibung</param>
;  <example>Beispielaufruf()</example>
;</comment>
Procedure Name2()             ; <-------- hier in Pos 1 Cursor setzen und nach rechts tippen bis nach die 2

  Protected.i Result


EndProcedure

Name2(

Tut man dies, dann wird die falsche Procedure im Popup gemeldet.

Re: Documentation Comment

Verfasst: 16.09.2019 14:33
von MenschMarkus
RSBasic hat geschrieben:Documentation Comment 1.1.0 wurde veröffentlicht.
...
@hjf
Kannst du es nochmal testen? Dein Prozessor müsste mit dieser Version nicht mehr dauerhaft überlastet sein, sondern nur einmal kurz, wenn die den Tab wechselst oder die PB-Datei speicherst.
...
SourceCode mit ca 24.000 Zeilen
CPU Last ist schon einiges geringer geworden
:allright:

Re: Documentation Comment

Verfasst: 08.10.2023 15:01
von RSBasic
Documentation Comment 1.1.1 wurde veröffentlicht.

Changelog:
  • Geändert: DPI-Compiler-Option ist jetzt aktiviert.
  • Optimiert: Neue Lexer-Version von Sicro. Es ist jetzt schneller. Danke an Sicro.
  • Hinzugefügt: Beispielcode-Datei

Re: Documentation Comment

Verfasst: 18.10.2023 13:46
von FS-1281
Hallo RSBasic,

danke für dein super Tool !

Mir ist noch ein Fehler aufgefallen.
Wenn ich zwei Module habe, die identischen Prozeduren enthalten, wird nicht die korrekte Prozedur angezeigt.

Es sollte beim Parsen auch das Modul mit berücksichtigt werden.

z.B. im Codeauszug unten wird immer der Kommentar für die "ToString" Prozedur des ersten Moduls angezeigt,
obwohl es sich um zwei unterschiedliche Prozeduren handelt.

Code: Alles auswählen


DeclareModule BitConverter
  ;- --------------------------------------------------------------------------
  ;-   Declaration Public Methods
  ;- --------------------------------------------------------------------------
    
  Declare.s ToString(Array value.a(1), startIndex=0, length=0) 
EndDeclareModule

Module BitConverter
  ;- --------------------------------------------------------------------------
  ;-   Public Methods
  ;- --------------------------------------------------------------------------  
   
  ;<comment>
  ;  <summary>Converts the numeric value of each element of a specified Array of bytes To its equivalent hexadecimal string representation.</summary>
  ;  <param><b>value</b>: An Array of bytes.</param>
  ;  <param><i>Optional</i> <b>startIndex</b>: The starting position within value.</param>
  ;  <param><i>Optional</i> <b>length</b>: The number of array elements in value to convert.</param>
  ;  <return>String of hexadecimal pairs, each value separated by hyphen. For example, "7F-2C-4A-00".</return>
  ;  <example>Str$ = BitConverter::ToString(value())</example>
  ;</comment>
  Procedure.s ToString(Array value.a(1), startIndex=0, length=0) 
  EndProcedure
EndModule

DeclareModule Guid
  
  Declare.s ToString(*Guid.UUID, ToUpper=#False)
 
EndDeclareModule

Module Guid

  ;<comment>
  ;  <summary>Returns a string representation of the value of Guid in registry format.</summary>
  ;  <param><b>*Guid</b>: Pointer to the UUID Structure</param>
  ;  <param><i>Optional </i><b>ToUpper</b>: Flag to set Output Uppercase</param>
  ;  <return>returns string with guid in registry format</return>
  ;  <example>RegGuid.s = Guid::ToString(@Guid)</example>
  ;</comment>
  Procedure.s ToString(*Guid.UUID, ToUpper=#False)
  
  EndProcedure
  
EndModule