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:
Wie funktioniert es?
Vor einer Prozedur erstellt man folgende Kommentare:
Code: Alles auswählen
;<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)
;...
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
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: https://www.rsbasic.de/downloads/downlo ... omment.zip
Ich würde mich über Feedbacks, Verbesserungsvorschläge, Fehlermeldungen oder Wünsche sehr freuen. Danke