Aktuelle Zeit: 07.12.2019 02:56

Alle Zeiten sind UTC + 1 Stunde [ Sommerzeit ]




Ein neues Thema erstellen Auf das Thema antworten  [ 75 Beiträge ]  Gehe zu Seite Vorherige  1, 2, 3, 4, 5, 6, 7, 8  Nächste
Autor Nachricht
 Betreff des Beitrags: Re: Documentation Comment
BeitragVerfasst: 19.07.2019 20:00 
Offline
Benutzeravatar

Registriert: 11.08.2005 19:08
@RSBasic:
Ich glaube, @MenschMarkus meint deine XML-Tags, nicht die PB-Schlüsselwörter.
Code:
;<summary>
soll automatisch ergänzt werden zu:
Code:
;<summary>{CURSOR}</summary>


@MenschMarkus:
Ist das Erstellen eines Templates in der PB-IDE keine Option für dich (Tools => Templates)?
Code:
;<comment>
;  <summary></summary>
;  <param></param>
;  <return></return>
;  <example></example>
;</comment>
Wenn mehrere Parameter vorhanden sind, kannst du die Parameter-Zeile schnell mit Strg + D verdoppeln.

_________________
Bild
Warum OpenSource eine Lizenz haben sollte
PureBasic-CodeArchiv-Rebirth: Git-Repository / Download -- Jede Hilfe ist willkommen!
Manjaro Xfce x64 (Hauptsystem) :: WindowsXP/Xubuntu x86 (VirtualBox) :: PureBasic (Linux: x86/x64, Windows: x86) :: jeweils neueste Version


Nach oben
 Profil  
Mit Zitat antworten  
 Betreff des Beitrags: Re: Documentation Comment
BeitragVerfasst: 19.07.2019 21:44 
Offline

Registriert: 30.04.2009 21:21
Sicro hat geschrieben:
@RSBasic:
Ich glaube, @MenschMarkus meint deine XML-Tags, nicht die PB-Schlüsselwörter.
Code:
;<summary>
soll automatisch ergänzt werden zu:
Code:
;<summary>{CURSOR}</summary>


@MenschMarkus:
Ist das Erstellen eines Templates in der PB-IDE keine Option für dich (Tools => Templates)?
Code:
;<comment>
;  <summary></summary>
;  <param></param>
;  <return></return>
;  <example></example>
;</comment>
Wenn mehrere Parameter vorhanden sind, kannst du die Parameter-Zeile schnell mit Strg + D verdoppeln.


Noch besser...[THUMBS UP SIGN].

_________________
Wissen schadet nur dem, der es nicht hat !


Nach oben
 Profil  
Mit Zitat antworten  
 Betreff des Beitrags: Re: Documentation Comment
BeitragVerfasst: 19.07.2019 22:58 
Offline
Benutzeravatar

Registriert: 11.08.2005 19:08
MenschMarkus hat geschrieben:
Noch besser...[THUMBS UP SIGN].
:)

Noch ein Vorschlag:
Befindet sich der Textcursor innerhalb
Code:
Procedure AddItem(List items(), itemText$, itemFlags)
und es wird eine festgelegte Tastenkombination gedrückt, wird das Tool z. B. mit dem Parameter --auto-comment nochmal separat gestartet und erstellt automatisch einen vorausgefüllten Dokumentationskommentar:
Code:
;<comment>
;  <summary></summary>
;  <param>List items(): </param>
;  <param>itemText$: </param>
;  <param>itemFlags: </param>
;  <return></return>
;  <example></example>
;</comment>
Procedure AddItem(List items(), itemText$, itemFlags)

_________________
Bild
Warum OpenSource eine Lizenz haben sollte
PureBasic-CodeArchiv-Rebirth: Git-Repository / Download -- Jede Hilfe ist willkommen!
Manjaro Xfce x64 (Hauptsystem) :: WindowsXP/Xubuntu x86 (VirtualBox) :: PureBasic (Linux: x86/x64, Windows: x86) :: jeweils neueste Version


Nach oben
 Profil  
Mit Zitat antworten  
 Betreff des Beitrags: Re: Documentation Comment
BeitragVerfasst: 19.07.2019 23:43 
Offline

Registriert: 30.04.2009 21:21
Sicro hat geschrieben:
und es wird eine festgelegte Tastenkombination gedrückt, wird das Tool z. B. mit dem Parameter --auto-comment nochmal separat gestartet und erstellt automatisch einen vorausgefüllten Dokumentationskommentar:
Code:
;<comment>
;  <summary></summary>
;  <param>List items(): </param>
;  <param>itemText$: </param>
;  <param>itemFlags: </param>
;  <return></return>
;  <example></example>
;</comment>
Procedure AddItem(List items(), itemText$, itemFlags)


Ja, gute Idee, ABER
funktioniert nur "einfach", wenn ich eine Prozedur neu schreibe.
Ändere ich eine bestehende Prozedur für die schon eine Dokumentation existiert, wird es schon aufwändig den Kommentar durchzuarbeiten und z.B. nur einen neuen Parameter an passender Stelle einzufügen.
Also Aufwändig für RSBasic, nicht für den Anwender :oops:

_________________
Wissen schadet nur dem, der es nicht hat !


Nach oben
 Profil  
Mit Zitat antworten  
 Betreff des Beitrags: Re: Documentation Comment
BeitragVerfasst: 20.07.2019 10:53 
Offline
Benutzeravatar

Registriert: 11.08.2005 19:08
MenschMarkus hat geschrieben:
funktioniert nur "einfach", wenn ich eine Prozedur neu schreibe.
Ändere ich eine bestehende Prozedur für die schon eine Dokumentation existiert, wird es schon aufwändig den Kommentar durchzuarbeiten
Ja, bestehende Dokumentationskommentare zu aktualisieren ist zu aufwendig. Wenn bereits ein Dokumentationskommentar besteht, sollte das Tool den Vorgang abbrechen.

_________________
Bild
Warum OpenSource eine Lizenz haben sollte
PureBasic-CodeArchiv-Rebirth: Git-Repository / Download -- Jede Hilfe ist willkommen!
Manjaro Xfce x64 (Hauptsystem) :: WindowsXP/Xubuntu x86 (VirtualBox) :: PureBasic (Linux: x86/x64, Windows: x86) :: jeweils neueste Version


Nach oben
 Profil  
Mit Zitat antworten  
 Betreff des Beitrags: Re: Documentation Comment
BeitragVerfasst: 21.07.2019 10:13 
Offline
Kommando SG1
Benutzeravatar

Registriert: 01.11.2005 13:34
Wohnort: Glienicke
Hallo RSBasic,

irgendwie bin ich zu blöd dein schönes Tool zu bedienen.
Dein Tool arbeitet richtig, wenn die Datei nicht in einem Projekt ist.
Hängt die Datei in einem Projekt, wird kein Kommentarfester mehr angezeigt :-(
(Als ob Projekt-Tabs nicht mehr geparst werden)

Irgendwelche Ideen?

_________________
Bild
 
BildBildBild


Nach oben
 Profil  
Mit Zitat antworten  
 Betreff des Beitrags: Re: Documentation Comment
BeitragVerfasst: 21.07.2019 11:10 
Offline
Admin
Benutzeravatar

Registriert: 05.10.2006 18:55
Wohnort: Berlin
Guten Morgen STARGÅTE,

du hast eine PN bekommen.

_________________
BildBildBildBild BildBild


Nach oben
 Profil  
Mit Zitat antworten  
 Betreff des Beitrags: Re: Documentation Comment
BeitragVerfasst: 24.07.2019 13:02 
Offline

Registriert: 30.04.2009 21:21
Hat mir ja keine Ruhe gelassen.

Für den Anfrang mal ein mini Templategenerator.
Datei Compilieren und speichern
Ausführbare Datei in PB unter Werkzeuge einbinden und mit beliebiger Tastenkombination verknüpfen
Nach Aufruf der Tastenkombination mit Strg+V das Template an aktuellen Cursorposition einfügen

Code:
; ====================================
; Comment Addon
; Author : menschmarkus
; Date   : 24.07.2019
; PB     : PB 5.70 LTS (x86)
; Licence: zur freien Verwendung
;          ohne Gewährleistung auf Funktion
; ====================================

Procedure CommentAddon()
  Protected Query.s, found.i=0, addondir.s, filelen.i
  ;{ ===== Temporäres Verzeichnis ermitteln, ggf. erzeugen =====
  If ExamineEnvironmentVariables()
    While NextEnvironmentVariable()
      If EnvironmentVariableName() = "TEMP"
        Query = EnvironmentVariableValue()
        found = 1
        Break
      EndIf
    Wend
  EndIf
  If found = 0
    MessageRequester("Fehler","Konnte temporäres Verzeichnis nicht finden",#MB_ICONERROR)
    End
  EndIf
  ;}
  ;{ ===== Addon Verzeichnis ermitteln, ggf. erzeugen =====
  found = 0
  addondir = Query
  SetCurrentDirectory(addondir)
  If ExamineDirectory(0,addondir,"")
    While NextDirectoryEntry(0)
      Select DirectoryEntryType(0)
        Case 2
          If DirectoryEntryName(0) = "PB_Addon"
            found = 1
            addondir + "\PB_Addon"
            SetCurrentDirectory(addondir)
           
            Break
          EndIf
      EndSelect
    Wend 
  EndIf
  FinishDirectory(0)
  ;}
  ;{ ===== Addon Verzeichnis erzeugen falls nicht vorhanden.
  ;        Falls nicht vorhanden, Basisdatei erstellen.
  ;        Falls vorhanden, Basisdatei einlesen  =====
  If found = 0
    addondir + "\PB_Addon"
    If CreateDirectory(addondir)
      SetCurrentDirectory(addondir)
      If CreateFile(0,"comment.addon")
        WriteStringN(0,";<comment>")
        WriteStringN(0,"; <summary></summary>")
        WriteStringN(0,"; <param></param>")
        WriteStringN(0,"; <return></return>")
        WriteStringN(0,"; <example></example>")
        WriteStringN(0,";</comment>")
        CloseFile(0)
      EndIf
    EndIf
  Else
    ReadFile(0,addondir + "\comment.addon")
    filelen = Lof(0)
    SetClipboardText(ReadString(0,#PB_File_IgnoreEOL,filelen))
    CloseFile(0)
  EndIf
  ;}
  EndProcedure
CommentAddon()


Ach ja, im Temp Verzeichnis kann die Datei "comment,addon" auch manuell nach eigenem Ermessen nachträglich editiert werden

Viel Vergnügen damit

_________________
Wissen schadet nur dem, der es nicht hat !


Nach oben
 Profil  
Mit Zitat antworten  
 Betreff des Beitrags: Re: Documentation Comment
BeitragVerfasst: 30.07.2019 20:16 
Offline
Admin
Benutzeravatar

Registriert: 05.10.2006 18:55
Wohnort: Berlin
Documentation Comment 1.0.7 wurde veröffentlicht.

Changelog:
  • Bugfix

_________________
BildBildBildBild BildBild


Nach oben
 Profil  
Mit Zitat antworten  
 Betreff des Beitrags: Re: Documentation Comment
BeitragVerfasst: 24.08.2019 15:30 
Offline
Benutzeravatar

Registriert: 10.09.2004 09:59
Ich hab hier mal was Kleines gebastelt.

Ach ja @RSBasic:
Kannst Du bei Gelegenheit die Ausrichtung bei mehrzeiligen param Angaben anpassen?
Bild

_________________
Link tot?
Ändere h3x0r.ath.cx in hex0rs.coderbu.de und alles wird gut.


Nach oben
 Profil  
Mit Zitat antworten  
Beiträge der letzten Zeit anzeigen:  Sortiere nach  
Ein neues Thema erstellen Auf das Thema antworten  [ 75 Beiträge ]  Gehe zu Seite Vorherige  1, 2, 3, 4, 5, 6, 7, 8  Nächste

Alle Zeiten sind UTC + 1 Stunde [ Sommerzeit ]


Wer ist online?

Mitglieder in diesem Forum: 0 Mitglieder und 2 Gäste


Sie dürfen keine neuen Themen in diesem Forum erstellen.
Sie dürfen keine Antworten zu Themen in diesem Forum erstellen.
Sie dürfen Ihre Beiträge in diesem Forum nicht ändern.
Sie dürfen Ihre Beiträge in diesem Forum nicht löschen.

Suche nach:
Gehe zu:  

 


Powered by phpBB © 2008 phpBB Group | Deutsche Übersetzung durch phpBB.de
subSilver+ theme by Canver Software, sponsor Sanal Modifiye