Sorry your browser is not supported!

You are using an outdated browser that does not support modern web technologies, in order to use this site please update to a new browser.

Browsers supported include Chrome, FireFox, Safari, Opera, Internet Explorer 10+ or Microsoft Edge.

AppGameKit Studio Chat / Feature Idea: Documenting user created function to show in help window

Author
Message
PetterJhon
User Offline
Joined: 6th Aug 2019
Location:
Posted: 6th Aug 2019 10:31
Hello everyone,,
I'm thinking of putting this in for a feature request, but just want to gauge if it is something everyone else would want or use.

So, when you need to know more about an AppGameKit command, you would press F1 while the command is highlighted in the code editor. This brings up the help doc for that command in the help tab to the left.

What I'm thinking is the same thing for our own functions. We could put a comment block just above or inside the function definition, and the studio editor could use that comment as a help doc for that function. Pressing F1 on the highlighted function name anywhere in code would bring up the function help in the same help tab just like normal help docs.

basicFanatic
2
Years of Service
User Offline
Joined: 7th Jun 2017
Location:
Posted: 6th Aug 2019 15:27
That sounds super useful! Could work for values too.
Onomatopoesie
User Offline
Joined: 6th Aug 2019
Location: Germany
Posted: 7th Aug 2019 12:00
Especially if you work after a long time with a source code, that would be really useful, I think. A great idea!
Scraggle
Moderator
16
Years of Service
User Offline
Joined: 10th Jul 2003
Location: Yorkshire
Dutchman
User Offline
Joined: 30th Mar 2019
Location:
Posted: 8th Aug 2019 00:45
I support this idea
+1
Jambo B
9
Years of Service
User Offline
Joined: 17th Sep 2009
Location: The Pit
Posted: 12th Aug 2019 13:58
Big +1 from here. Especially if writing a library of functions for other people to use.
PHeMoX
1
Years of Service
User Offline
Joined: 9th Jan 2018
Location:
Posted: 12th Aug 2019 18:29
+1 from me also. Oh and please make the text in the help window selectable, so we can copy things we want to use from it or search for other commands from there. Would be a time saver.

Login to post a reply

Server time is: 2019-08-26 04:59:25
Your offset time is: 2019-08-26 04:59:25