In my opinion it's one of the most important features currently missing in the PB IDE (apart from refactoring tools). For those of you who are not familiar with it: Think of it as a way more advanced "status bar quick-help text" that even shows descriptions for each parameter and -- most importantly -- can be easily defined for your very own procedures.
In PB this quick-help feature would basically analyze the source code and pick out information that directly belongs to each procedure (could be extended to macro, variable, constant definitions too). Then whenever the mouse hovers over that procedure name (anywhere in the code!) a small window opens up (kind of like auto-complete) and shows the defined relevant information in a consistently formatted way. It could look like this:
Code: Select all
; This procedure does this and that.
; @param var Description of first parameter
; @param string Description of second parameter
; @return #True if successful, else #False
; @source <a href="http://www.purebasic.fr/english/viewtopic.php?f=3&t=54831">PB Forum</a>
; @version 2015-10-10, 1.1.0
Procedure MyProc(var.i, string.s)
; [...]
EndProcedure
MyProc(123, "test") ; Hovering over 'MyProc' opens a mini-help with the above infoI would even like to write such a tool just for myself (if not everyone likes the annotation style mentioned above). Though, first I would have to write a PB parser to get all the required code information... feature request (IDE - Access to internal code information)
Edit 2 (2015-10-10):
Improved wording of title and extended description.
).
