With this tool it is possible to document your own procedures, the individual parameters and the return value as in C#.
The descriptions are automatically displayed in the PB editor when you write a procedure call or click in the parameter list.
Screenshot:
How does it work?
Before a procedure, you create the following comments:
Code: Select all
;<comment>
; <summary>My function description...</summary>
; <param>Parameter1: Description of the first parameter</param>
; <param>Parameter2: Description of the second parameter</param>
; <param>Parameter3: Description of the third parameter</param>
; <return>Description of the return value</return>
; <example>MyFunction(1, 2, "Hello")</example>
;</comment>
Procedure MyFunction(Parameter1, Parameter2.i, Parameter3.s)
;...
These comments are automatically determined by my tool (after 3 seconds at the latest) and displayed when you write a procedure call or click in the parameter list.
The following formatting can be used in the comments:
- <b>Text</b>: Bold
- <i>Text</i>: Italic
- <u>Text</u>: Underlining
- <s>Text</s>: Strikethrough
- <sup>Text</sup>: Superscript
- <sub>Text</sub>: Subscript
- https://www.rsbasic.de: Clickable web link
- file:///C:\...\Info.txt: Clickable file link (Hint: Please use path with spaces "%20".)
- <br>: Line break
Requirements:
The setting "Show full source path in title bar" must be enabled because I have no other way to find the path to the PB file.
Download: https://www.rsbasic.de/downloads/downlo ... omment.zip
I would be very pleased about feedbacks, improvement suggestions, error messages or wishes. Thanks