Documentation Comment

Anwendungen, Tools, Userlibs und anderes nützliches.
Benutzeravatar
Sicro
Beiträge: 955
Registriert: 11.08.2005 19:08
Kontaktdaten:

Re: Documentation Comment

Beitrag von Sicro »

@SDL:
Im Root-Tag <comment>...</comment> werden keine losen Texte unterstützt.
Bild
Warum OpenSource eine Lizenz haben sollte :: PB-CodeArchiv-Rebirth :: Pleasant-Dark (Syntax-Farbschema) :: RegEx-Engine (kompiliert RegExes zu NFA/DFA)
Manjaro Xfce x64 (Hauptsystem) :: Windows 10 Home (VirtualBox) :: Neueste PureBasic-Version
Benutzeravatar
SDL
Beiträge: 65
Registriert: 15.09.2006 05:19
Computerausstattung: MSI 990FXA-GD80
AMD FX-8350(3,1GHz) 4-4,4GHz
Corsair Dominator Platinum 8GB 2133 (2240)
2 Nvidia GeForce GTX 550Ti
Xilence XQ semipassives Netzteil 750Watt
SATA III WDC WD10 1TB
SATA III SSD Toshiba 128 GB
SATA III SSD Samsung 840 EVO 250 GB
eSATA WDC WD SE16 500 GB

Wassergekühlt

Win 7 pro
Leistungsindex 7,8
Wohnort: Hansestadt Stendal

Re: Documentation Comment

Beitrag 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
Zu meiner Schulzeit war die Bildung kostenlos, für einige aber Umsonst.
Benutzeravatar
Sicro
Beiträge: 955
Registriert: 11.08.2005 19:08
Kontaktdaten:

Re: Documentation Comment

Beitrag 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.
Bild
Warum OpenSource eine Lizenz haben sollte :: PB-CodeArchiv-Rebirth :: Pleasant-Dark (Syntax-Farbschema) :: RegEx-Engine (kompiliert RegExes zu NFA/DFA)
Manjaro Xfce x64 (Hauptsystem) :: Windows 10 Home (VirtualBox) :: Neueste PureBasic-Version
hjf
Beiträge: 52
Registriert: 12.02.2014 20:02

Re: Documentation Comment

Beitrag 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.
MenschMarkus
Beiträge: 220
Registriert: 30.04.2009 21:21
Computerausstattung: i5-2300 (2.8 Ghz) Win10 -64bit / PB 5.73 LTS

Re: Documentation Comment

Beitrag 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:
Wissen schadet nur dem, der es nicht hat !
Benutzeravatar
RSBasic
Admin
Beiträge: 8022
Registriert: 05.10.2006 18:55
Wohnort: Gernsbach
Kontaktdaten:

Re: Documentation Comment

Beitrag 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
Aus privaten Gründen habe ich leider nicht mehr so viel Zeit wie früher. Bitte habt Verständnis dafür.
Bild
Bild
Benutzeravatar
FS-1281
Beiträge: 8
Registriert: 13.05.2015 15:44

Re: Documentation Comment

Beitrag 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

Antworten