Aktuelle Zeit: 07.12.2019 04:13

Alle Zeiten sind UTC + 1 Stunde [ Sommerzeit ]




Ein neues Thema erstellen Auf das Thema antworten  [ 75 Beiträge ]  Gehe zu Seite 1, 2, 3, 4, 5 ... 8  Nächste
Autor Nachricht
 Betreff des Beitrags: Documentation Comment
BeitragVerfasst: 22.06.2019 10:03 
Offline
Admin
Benutzeravatar

Registriert: 05.10.2006 18:55
Wohnort: Berlin
Hallo :)

Mit diesem Werkzeug ist es möglich, die eigenen Prozeduren, die einzelnen Parameter und den Rückgabewert wie in C# zu dokumentieren.
Die Beschreibungen werden automatisch im PB-Editor angezeigt, wenn man einen Prozeduraufruf schreibt oder in die Parameterliste klickt.

Screenshot:
Bild

Wie funktioniert es?
Vor einer Prozedur erstellt man folgende Kommentare:
Code:
;<comment>
;  <summary>Meine Funktionsbeschreibung...</summary>
;  <param>Parameter1: Beschreibung des ersten Parameters</param>
;  <param>Parameter2: Beschreibung des zweiten Parameters</param>
;  <param>Parameter3: Beschreibung des dritten Parameters</param>
;  <return>Beschreibung des Rückgabewertes</return>
;  <example>MeineFunktion(1, 2, "Hello")</example>
;</comment>
Procedure MeineFunktion(Parameter1, Parameter2.i, Parameter3.s)
;...


";<comment>" und ";</comment>" können im PB-Einstellungsfenster als Faltmarken hinzugefügt und ausgeblendet werden.

Diese Kommentare werden von meinem Werkzeug automatisch ermittelt (spätestens nach 3 Sekunden) und angezeigt, wenn man einen Prozeduraufruf schreibt oder in die Parameterliste klickt.

In den Kommentaren können folgende Formatierungen benutzt werden:
  • <b>Text</b>: Fett
  • <i>Text</i>: Kursiv
  • <u>Text</u>: Unterstrichen
  • <s>Text</s>: Durchgestrichen
  • <sup>Text</sup>: Hochgestellt
  • <sub>Text</sub>: Tiefgestellt
  • https://www.rsbasic.de: Klickbarer Web-Link
  • file:///C:\...\Info.txt: Klickbarer Datei-Link (Hinweis: Pfad mit Leerzeichen bitte "%20" benutzen)
  • <br>: Zeilenumbruch

Installation:
Bild

Voraussetzungen:
Die Einstellung "Vollständigen Quellcode-Pfad in der Titelzeile anzeigen" muss aktiviert sein, weil ich keine andere Möglichkeit habe, den Pfad zur PB-Datei zu ermitteln.

Download: http://www.rsbasic.de/downloads/downloa ... omment.zip
Bild

Ich würde mich über Feedbacks, Verbesserungsvorschläge, Fehlermeldungen oder Wünsche sehr freuen. Danke :)

_________________
BildBildBildBild BildBild


Nach oben
 Profil  
Mit Zitat antworten  
 Betreff des Beitrags: Re: Documentation Comment
BeitragVerfasst: 22.06.2019 14:23 
Offline
Benutzeravatar

Registriert: 08.09.2004 08:21
Wohnort: Amphibios 9
Hammer! :allright:

Ich bin in letzter Zeit verstärkt mit B4J unterwegs und die IDE unterstützt das auch. Sehr nützlich.

Eine Anmerkung:

Es scheint wohl Probleme mit Umlauten zu geben:

Bild


Unschönheit:

Das Hilfe-Fenster sollte sich schließen, wenn man im Code mit dem Mausrad scrollt.


Tüpfelchen auf dem ı:

In B4J kann man auch einen Bereich angeben, in dem man einen kleinen Beispiel-Schnippsel eintragen kann. Mit Klick auf 'Copy' wird dieser dann in die Zwischenablage gespeichert und man kann ihn dann im Editor einfügen;

Bild

Bild

Danke & Grüße ... Peter

_________________
Schrödingers Smiley :):


Nach oben
 Profil  
Mit Zitat antworten  
 Betreff des Beitrags: Re: Documentation Comment
BeitragVerfasst: 22.06.2019 17:47 
Offline
Admin
Benutzeravatar

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

Changelog:
  • Hinzugefügt: "<example" wurde hinzugefügt, um für die eigene Funktion einen Beispielcode zum Einfügen bereitzustellen.
  • Bugfix: Summary-Fenster wird jetzt automatisch geschlossen, wenn gescrollt wird.
  • Bugfix: Umlautprobleme bei UTF8



Kiffi hat geschrieben:
Ich bin in letzter Zeit verstärkt mit B4J unterwegs und die IDE unterstützt das auch. Sehr nützlich.

Ah, ich habe mich mal gefragt, was für IDEs es noch gibt, die sowas können, aber da fand ich nur Visual Studio.

Kiffi hat geschrieben:
Es scheint wohl Probleme mit Umlauten zu geben:

Sollte behoben sein. Kannst du es bei dir auch nochmal testen?

Kiffi hat geschrieben:
Das Hilfe-Fenster sollte sich schließen, wenn man im Code mit dem Mausrad scrollt.

Behoben

Kiffi hat geschrieben:
In B4J kann man auch einen Bereich angeben, in dem man einen kleinen Beispiel-Schnippsel eintragen kann. Mit Klick auf 'Copy' wird dieser dann in die Zwischenablage gespeichert und man kann ihn dann im Editor einfügen;

Gute Idee, wurde umgesetzt. Da das ein EditorGadget ist, kann man den hinterlegten Beispielcode mit der Maus und Tastatur kopieren und einfügen.

_________________
BildBildBildBild BildBild


Nach oben
 Profil  
Mit Zitat antworten  
 Betreff des Beitrags: Re: Documentation Comment
BeitragVerfasst: 22.06.2019 19:47 
Offline
Benutzeravatar

Registriert: 08.09.2004 08:21
Wohnort: Amphibios 9
RSBasic hat geschrieben:
Ah, ich habe mich mal gefragt, was für IDEs es noch gibt, die sowas können, aber da fand ich nur Visual Studio.
Visual Studio Code kann ebenfalls (ist ja auch quasi aus dem selbem Haus ;-)).

RSBasic hat geschrieben:
Kiffi hat geschrieben:
[...] Umlaute [...]
Sollte behoben sein.
yess! :D

RSBasic hat geschrieben:
Kiffi hat geschrieben:
[...] Mausrad [...]
Behoben
Primstens. :D

RSBasic hat geschrieben:
Da das ein EditorGadget ist, kann man den hinterlegten Beispielcode mit der Maus und Tastatur kopieren und einfügen.

Sauber, Danke! :allright:

ich habe jetzt mal ein wenig weiter probiert. Insgesamt scheint das Erstellen und Ausprobieren der Documentation-Fenster doch noch ein wenig hakelig zu sein. Mir scheint, als ob Du das Fenster erst gar nicht anzeigst, wenn die Documentation-Syntax nicht OK ist. Nach wiederholter Veränderung der Documentation erschien dann irgendwann auch mal das Fenster. Ich musste meinen Code allerdings zwischenzeitig mehrfach abspeichern. Änderungen in der Documenation werden auch nicht immer sofort übernommen (siehe das gif unten).

Und dann gibt es noch ein Positionierungsproblem des Fensters:

Bild

Grüße ... Peter

_________________
Schrödingers Smiley :):


Nach oben
 Profil  
Mit Zitat antworten  
 Betreff des Beitrags: Re: Documentation Comment
BeitragVerfasst: 22.06.2019 19:58 
Offline
Admin
Benutzeravatar

Registriert: 05.10.2006 18:55
Wohnort: Berlin
Kiffi hat geschrieben:
Ich musste meinen Code allerdings zwischenzeitig mehrfach abspeichern. Änderungen in der Documenation werden auch nicht immer sofort übernommen (siehe das gif unten).

Es liegt daran:
RSBasic hat geschrieben:
Damit mein Werkzeug alle erstellten Beschreibungskommentare aus allen PB-Dateien lesen kann, wird das ganze Projekt mit dem Compiler-Parameter "/PREPROCESS" im Temp-Verzeichnis in eine PB-Datei zusammengefasst, damit mein Werkzeug nicht alle Macros und Includes auflösen muss.
Leider erlaubt der Compiler-Parameter "/PREPROCESS" keine Syntax-Fehler. Aus dem Grund ist es wichtig, dass das Projekt ohne Syntax-Fehler kompilierbar ist, wenn man neue Beschreibungskommentare hinzufügen möchte.


Neue Summary-Änderung kann erst ausgelesen werden, wenn im Quellcode keine Syntax-Fehler gibt. Wenn du "Test(" entfernst und bis zu 3 Sekunden wartest, dann sollte die von dir geänderte Beschreibung gelesen und im Informationsfenster angezeigt werden.
Es ist aufgrund der Einschränkung des Compiler-Parameters "/PREPROCESS" leider nicht anders möglich, da dieser Parameter keine Syntax-Fehler zulässt, was meiner Meinung nach suboptimal ist bzw. nicht dafür zuständig sein sollte.
Die einzige Alternative wäre, wenn ich die Funktion "/PREPROCESS" nachbaue und alle Inkludes und Macros auflöse, um alle Dateien eines Projektes auszulesen.

Kiffi hat geschrieben:
Und dann gibt es noch ein Positionierungsproblem des Fensters:

Kannst du mir bei deiner Testdatei ein paar Informationen geben wie z.B. ob Reintext oder UTF8 usw.? Danke im Voraus

_________________
BildBildBildBild BildBild


Nach oben
 Profil  
Mit Zitat antworten  
 Betreff des Beitrags: Re: Documentation Comment
BeitragVerfasst: 22.06.2019 23:39 
Offline
Benutzeravatar

Registriert: 11.08.2005 19:08
RSBasic hat geschrieben:
Die einzige Alternative wäre, wenn ich die Funktion "/PREPROCESS" nachbaue und alle Inkludes und Macros auflöse, um alle Dateien eines Projektes auszulesen.
Es ist schon spät, aber: Ist es wirklich erforderlich, die Macros aufzulösen? Ich denke nicht. Und die Include-Befehle zu verarbeiten ist einfach…

_________________
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: 22.06.2019 23:43 
Offline
Benutzeravatar

Registriert: 23.07.2011 02:08
f#@k yeah!
Is ja der Hammer.
Ich hatte bisher noch keine IDE, die das konnte. In meinem letzten großen Projekt, habe ich eine Art Lexer verwendet um ein automatisch generiertes Hilfedokument zu erstellen, aber in "Echtzeit" in der IDE ist natürlich noch viel besser!

edit: Was Sicro sagt, ergibt eigentlich Sinn. So kann man auch Macros erstellen und dokumentieren, was ja nicht geht, wenn du sie vorher auflöst.

_________________
Signatur und so


Nach oben
 Profil  
Mit Zitat antworten  
 Betreff des Beitrags: Re: Documentation Comment
BeitragVerfasst: 23.06.2019 05:45 
Offline
Benutzeravatar

Registriert: 04.08.2009 17:24
Derren hat geschrieben:
Was Sicro sagt, ergibt eigentlich Sinn. So kann man auch Macros erstellen und dokumentieren, was ja nicht geht, wenn du sie vorher auflöst.
Es geht nicht darum, dass RSBasic in deinem Sourcecode was ändert, es geht nur darum was notwendig wäre um /PREPROCESS nachzubilden.

Was Sicro schreibt macht übrigens überhaupt keinen Sinn, alleine die Includes zu verarbeiten ist nicht gerade trival. Wenn du /PREPROCESS kugelsicher nachbilden willst, dann bist du wahrscheinlich bei 50k Programmzeilen.


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

Registriert: 29.08.2004 11:05
Wohnort: Berlin
Die Anzeige erfolgt nur, wenn der Procedurename auch mit richtiger Groß/Kleinschrift erfolgt.


Nach oben
 Profil  
Mit Zitat antworten  
 Betreff des Beitrags: Re: Documentation Comment
BeitragVerfasst: 23.06.2019 17:52 
Offline
Admin
Benutzeravatar

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

Changelog:
  • Geändert: Keine Groß- und Kleinschreibung


IB-Software hat geschrieben:
Die Anzeige erfolgt nur, wenn der Procedurename auch mit richtiger Groß/Kleinschrift erfolgt.

Erledigt

_________________
BildBildBildBild BildBild


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 1, 2, 3, 4, 5 ... 8  Nächste

Alle Zeiten sind UTC + 1 Stunde [ Sommerzeit ]


Wer ist online?

Mitglieder in diesem Forum: 0 Mitglieder und 4 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:  
cron

 


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