IDE - allow detailed help information for procedures

Got an idea for enhancing PureBasic? New command(s) you'd like to see?
User avatar
Michael Vogel
Addict
Addict
Posts: 2797
Joined: Thu Feb 09, 2006 11:27 pm
Contact:

IDE - allow detailed help information for procedures

Post by Michael Vogel »

When you enter the parameters of an internal procedure, you will get great help by the IDE, displaying the needed parameters and some information for using the procedure. A self defined procedure does only show the parameters, what about adding some supprting user comments?

This information could be taken from the definition line (or the line directly below the function header), when a certain marker will be seen (e.g. '>>'):

Code: Select all

Procedure.s ShortString(s.s,n); >> add this comment to the status help...
	; >> ...or this?
	If Len(s)>n
		ProcedureReturn Left(s,n)+"…"
	Else
		ProcedureReturn s
	EndIf
EndProcedure
The status line could show something like
ShortString(s.s,n.i) – shorten string 's' to a maximum length of 'n', by adding '...'
now