AutoComplete procedure descriptions through comments

Got an idea for enhancing PureBasic? New command(s) you'd like to see?
Henry00
User
User
Posts: 88
Joined: Thu Jul 12, 2012 7:00 pm
Location: Germany
Contact:

AutoComplete procedure descriptions through comments

Post by Henry00 »

It would be incredibly useful to have the ability to create AutoComplete comments in Procedures, Variables, #Constants and more.
Currently when a build-in procedure is typed you are able to get a small description:

Image

However it is currently not possible to add these to your own procedures.

Code: Select all

Procedure.l Prt(Origin$, Message$) ; This is a tailbite single-line description comment.

; brief: Logs an error message. Do not use directly, instead use the GError Macro.
; param: Origin$
;   Information origin and class information.
; param: Message$
;   The message describing the event.
; return: Length of message.
Procedure.l Prt(Origin$, Message$)
The syntax is completely up to the developers, I simply hope we will one day see this feature.
Thank you so much for all your hard work!
User avatar
skywalk
Addict
Addict
Posts: 4211
Joined: Wed Dec 23, 2009 10:14 pm
Location: Boston, MA

Re: AutoComplete procedure descriptions through comments

Post by skywalk »

The nice thing about standards is there are so many to choose from. ~ Andrew Tanenbaum
c4s
Addict
Addict
Posts: 1981
Joined: Thu Nov 01, 2007 5:37 pm
Location: Germany

Re: AutoComplete procedure descriptions through comments

Post by c4s »

The following request is pretty much related: eclipse's javadoc-like hover info
If any of you native English speakers have any suggestions for the above text, please let me know (via PM). Thanks!
Henry00
User
User
Posts: 88
Joined: Thu Jul 12, 2012 7:00 pm
Location: Germany
Contact:

Re: AutoComplete procedure descriptions through comments

Post by Henry00 »

c4s wrote:The following request is pretty much related: eclipse's javadoc-like hover info
This is exactly what I wish to see. PureBasic is having no trouble at all finding procedures/variables and so forth for the current AutoComplete list. It would be a small addition to the search algorithm and IDE that would be a blast to have. If the AutoComplete list had icons too it would be easier to tell what entry is a function, what is a global variable, what is a local variable, etc.
Post Reply