Some time ago I was playing around in the AutoITTools.lua file and learned that there was a function for generating function headers. For reasons I don't know, it was never added to the scite tools menu. So if you would like to get it working here is how I got it to work.
Add this code to file au3.properties located in "C:\Program Files\AutoIt3\SciTE\properties". You can also get to it from Scite menu Options --> open au3.properties. Restart Scite and it should be in your menu.
# 37 Generates a function header and inserts it into the document.
command.name.37.$(au3)=Generate Function Header
command.subsystem.37.$(au3)=3
command.37.$(au3)=InvokeTool AutoItTools.InsertFunctionHeader
command.shortcut.37.$(au3)=Ctrl+Alt+H
command.save.before.37.$(au3)=2
The generated header will look something like this
; ===================================================================
; _ExampleFunction($iKey, ByRef $second, $third, $forth = 4, $fifth = 5, $sixth = 6)
;
; Description -
; Parameters:
; $iKey - IN -
; $second - IN/OUT -
; $third - IN -
; $forth - IN/OPTIONAL -
; $fifth - IN/OPTIONAL -
; $sixth - IN/OPTIONAL -
; Returns:
; Success -
; Error -
; Remarks -
; ===================================================================
Func _ExampleFunction($iKey, ByRef $second, $third, $forth = 4, $fifth = 5, $sixth = 6)
;;
EndFunc
I also made a modified version of these functions that will generate a header more like the ones you are used to seeing around autoit.
To use copy and paste these two functions attached to file AutoITtools.lua located in C:\Program Files\AutoIt3\SciTE\LUA.
CreateAutoITFunctionHeader.zip
Then again, add this code to file au3.properties (code is different from above code)
# 37 Generates a function header and inserts it into the document.
command.name.37.$(au3)=Generate Function Header
command.subsystem.37.$(au3)=3
command.37.$(au3)=InvokeTool AutoItTools.InsertAutoitFunctionHeader
command.shortcut.37.$(au3)=Ctrl+Alt+H
command.save.before.37.$(au3)=2
Only part I couldn't figure out was how to set default parameters..
; #FUNCTION# ====================================================================================================
; Name...........: _ExampleFunction
; Description ...:
; Syntax.........: _ExampleFunction($iKey , ByRef $second, $third [, $forth = [, $fifth = [, $sixth = ]]])
; Parameters ....: $iKey -
; $second -
; $third -
; $forth -
; $fifth -
; $sixth -
; Return values .: Success -
; Failure -
; Author ........: Beege
; Modified.......:
; Remarks .......: None
; Link ..........:
; Example .......:
; ===============================================================================================================
Func _ExampleFunction($iKey, ByRef $second, $third, $forth = 4, $fifth = 5, $sixth = 6)
;;
EndFunc
Don't forget to add your name to the "Author" variable. Let me know if you have any problems.