- Offizieller Beitrag
Mal wieder ein kleines Tool:
Für alle Funktionen, die per #Include eingebunden sind, lässt sich hiermit aus der Include-Datei die Funktionsbeschreibung auslesen. Erkannt werden auch Includes mit relativen Pfadangaben zum Skriptverzeichnis. Recht nützlich für eigene UDF, bei denen man mal schnell die kpl. Parameterbeschreibung braucht. Aber auch bei den AutoIt eigenen UDF ist es manchmal recht hilfreich die originale Funktionsbeschreibung zu lesen, bzw. sie in der Konsole lesen zu können, während man die Parameter für die Funktion setzen will. Erspart das switchen in das Hilfefenster.
Wie gehts?
Die Datei "ShowFuncDescript.lua" in euren Lua-Skriptordner packen.
Eintrag in SciTEUser.properties
#44 Show Func Description
command.name.44.*=Show Func Description
command.44.*=dofile "C:\PFAD\ZUR\ShowFuncDescript.lua"
command.mode.44.*=subsystem:lua
command.shortcut.44.*=Ctrl+Alt+F
Statt der 44 könnt ihr auch eine andere freie Nummer verwenden.
Den HotKey könnt ihr natürlich auch anpassen.
In einem AU3-Skript den Cursor in den Funktionsnamen eines UDF-Aufrufes setzen und den HotKey ausführen. Ist eine Funktionsbeschreibung vorhanden (Kommentarzeilen direkt vor der Funktionsdeklaration), wird diese in die Konsole ausgegeben.
Viel Spaß damit.
EDIT 2018-01-20
- gefixed: Problem bei Datei ohne BOM
- added: Zuerst wird die Beschreibung im aktuell geöffneten Skript gesucht, erst dann in Includes.
v0.2
EDIT 2018-01-24
- added: Die Funktionsbeschreibung kann auch als Calltip angezeigt werden. Dazu einen Eintrag in SciTEUser.properties
# function description as calltip 0/1 No/Yes (default "0" = console output)
show.description.calltip=1
v0.3