Jump to content

SciTE - show function description


BugFix
 Share

Recommended Posts

This tool gets the function description from any declared function, inside the current script or in include files. Recognized as description will all commentlines directly above the "Func function_name(param)" whithout empty lines. (only single comments - none comment blocks)
It's very useful for non default UDF, which have none help entry. 

Set the cursor inside the function name by its call. Hit the hotkey and the description will written in the SciTE output pane.

Installation:
Save the file  "ShowFuncDescript.lua".
In "SciTEUser.properties":

#44 Show Function Description
command.name.44.*=Show Function Description
command.44.*=dofile C:\your\path\ShowFuncDescript.lua
command.mode.44.*=subsystem:lua
command.shortcut.44.*=Ctrl+Alt+F10

Replace the "44" with a free number from your properties file and use a (free) shortcut of your choice. Modify the path of the stored file.

 

EDIT: May be, you like to have the description as calltip. You can do it with the new version.
Add in "SciTEUser.properties"

#~ function description as calltip 0/1 No/Yes (default "0" = console output)
show.description.calltip=1

ShowFuncDescript.lua

Edited by BugFix

Best Regards BugFix  

Link to comment
Share on other sites

cool lua script. Some editors, like Sublime Text have built in Goto Anything that can find it if you open the folders to your project. tells you all the places it is referenced in as well. However, even though Sublime Text is great and can run AutoIT, I still use The editor for AutoIT, because it is needed for advanced IUIAutomation stuff. I can't get the IUI stuff to execute properly under Sublime, but perfectly with the native editor, the full version though.

THANKS! Rock on.

Edited by Earthshine

My resources are limited. You must ask the right questions

 

Link to comment
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
 Share

  • Recently Browsing   0 members

    • No registered users viewing this page.
×
×
  • Create New...