nitekram

Tidy Change/Update Function Info?

7 posts in this topic

#1 ·  Posted (edited)

How would I go about adding the following to every function, after calling Tidy? Is it a hard process?

I would want it to fill in:

  • Name of the function
  • Parameters Variable Names from the function, and put them in place - adding more parameter spaces as needed
  • Fill in the created date
; #FUNCTION# ====================================================================================================================
; Name ..........: $NameOfFunction
; Description ...: 
; Syntax ........: 
; Parameters ....: $Param_1
;                  $Param_2
;                  $Param_3
; Return values .: 
; Author ........: 
; Created .......:
; Modified ......:
; Remarks .......:
; Related .......:
; Link ..........: 
; Example .......: 
; ===============================================================================================================================

; Also, was wondering, how hard it would be to create another tool, as I seem to always want to see the values being sent to a function, maybe a HotKey (script) that can put a

MessageBox box/ConsoleWrite at the top off all the functions (or at least the one high lighted? With the name of the function as title, and each parameter/variable in the header, put its name and value on separate lines.

 

EDIT

Or the syntax of a UDF - do not remember where that is, but will see if I can find it.

 

EDIT 2

Found this, I assume it should be added, so when I find it, I guess I will

https://www.autoitscript.com/wiki/Best_coding_practices

 

Edited by nitekram

All by me:

"Sometimes you have to go back to where you started, to get to where you want to go." 

"Everybody catches up with everyone, eventually" 

"As you teach others, you are really teaching yourself."

From my dad

"Do not worry about yesterday, as the only thing that you can control is tomorrow."

 

WindowsError.gif

WIKI | Tabs; | Arrays; | Strings | Wiki Arrays | How to ask a Question | Forum Search | FAQ | Tutorials | Original FAQ | ONLINE HELP | UDF's Wiki | AutoIt PDF

AutoIt Snippets | Multple Guis | Interrupting a running function | Another Send

StringRegExp | StringRegExp Help | RegEXTester | REG TUTOR | Reg TUTOT 2

AutoItSetOption | Macros | AutoIt Snippets | Wrapper | Autoit  Docs

SCITE | SciteJump | BB | MyTopics | Programming | UDFs | AutoIt 123 | UDFs Form | UDF

Learning to script | Tutorials | Documentation | IE.AU3 | Games? | FreeSoftware | Path_Online | Core Language

Programming Tips

Excel Changes

ControlHover.UDF

GDI_Plus

Draw_On_Screen

GDI Basics

GDI_More_Basics

GDI Rotate

GDI Graph

GDI  CheckExistingItems

GDI Trajectory

Replace $ghGDIPDll with $__g_hGDIPDll

DLL 101?

Array via Object

GDI Swimlane

GDI Plus French 101 Site

GDI Examples UEZ

GDI Basic Clock

GDI Detection

Ternary operator

Share this post


Link to post
Share on other sites



Position the cursor on a Func line and press Ctrl+Alt+H. This will insert an UDF header.


My UDFs and Tutorials:

Spoiler

UDFs:
Active Directory (NEW 2017-04-18 - Version 1.4.8.0) - Download - General Help & Support - Example Scripts - Wiki
OutlookEX (NEW 2017-02-27 - Version 1.3.1.0) - Download - General Help & Support - Example Scripts - Wiki
ExcelChart (2015-04-01 - Version 0.4.0.0) - Download - General Help & Support - Example Scripts
Excel - Example Scripts - Wiki
Word - Wiki
PowerPoint (2015-06-06 - Version 0.0.5.0) - Download - General Help & Support

Tutorials:
ADO - Wiki

 

Share this post


Link to post
Share on other sites

#3 ·  Posted (edited)

WOW,...all this time and I never knew that lol

And just so I feel stupid, I went ahead and looked under tools, and there it was.

And I see, my other request is listed there too...see I am not too far off my rocker.

Ctrl+Shift+D = debug, messagebox

Alt+D = debug, console

 

EDIT

I get this for messagebox

MsgBox(262144, 'Debug line ~' & @ScriptLineNumber, 'Selection:' & @CRLF & 'Func' & @CRLF & @CRLF & 'Return:' & @CRLF & Func)

Are you supposed to enter Function name?

 

Edited by nitekram

All by me:

"Sometimes you have to go back to where you started, to get to where you want to go." 

"Everybody catches up with everyone, eventually" 

"As you teach others, you are really teaching yourself."

From my dad

"Do not worry about yesterday, as the only thing that you can control is tomorrow."

 

WindowsError.gif

WIKI | Tabs; | Arrays; | Strings | Wiki Arrays | How to ask a Question | Forum Search | FAQ | Tutorials | Original FAQ | ONLINE HELP | UDF's Wiki | AutoIt PDF

AutoIt Snippets | Multple Guis | Interrupting a running function | Another Send

StringRegExp | StringRegExp Help | RegEXTester | REG TUTOR | Reg TUTOT 2

AutoItSetOption | Macros | AutoIt Snippets | Wrapper | Autoit  Docs

SCITE | SciteJump | BB | MyTopics | Programming | UDFs | AutoIt 123 | UDFs Form | UDF

Learning to script | Tutorials | Documentation | IE.AU3 | Games? | FreeSoftware | Path_Online | Core Language

Programming Tips

Excel Changes

ControlHover.UDF

GDI_Plus

Draw_On_Screen

GDI Basics

GDI_More_Basics

GDI Rotate

GDI Graph

GDI  CheckExistingItems

GDI Trajectory

Replace $ghGDIPDll with $__g_hGDIPDll

DLL 101?

Array via Object

GDI Swimlane

GDI Plus French 101 Site

GDI Examples UEZ

GDI Basic Clock

GDI Detection

Ternary operator

Share this post


Link to post
Share on other sites

So today is a good day as you have learned something new ;)


My UDFs and Tutorials:

Spoiler

UDFs:
Active Directory (NEW 2017-04-18 - Version 1.4.8.0) - Download - General Help & Support - Example Scripts - Wiki
OutlookEX (NEW 2017-02-27 - Version 1.3.1.0) - Download - General Help & Support - Example Scripts - Wiki
ExcelChart (2015-04-01 - Version 0.4.0.0) - Download - General Help & Support - Example Scripts
Excel - Example Scripts - Wiki
Word - Wiki
PowerPoint (2015-06-06 - Version 0.0.5.0) - Download - General Help & Support

Tutorials:
ADO - Wiki

 

Share this post


Link to post
Share on other sites

#5 ·  Posted (edited)

Everyday I learn something new is a good/great day.

I updated my post, not sure what is supposed to be the fix for the error I get

MsgBox(262144, 'Debug line ~' & @ScriptLineNumber, 'Selection:' & @CRLF & 'Func' & @CRLF & @CRLF & 'Return:' & @CRLF & Func)

error: syntax error on the last part Func

 

EDIT

And I still like my idea of getting the parameters broken out into the message box or console

 

EDIT2

And if I highlight the function, I get this, with cannot be an expression

MsgBox(262144, 'Debug line ~' & @ScriptLineNumber, 'Selection:' & @CRLF & 'Func CtrlMove(ByRef $g_aCtrls, $iCtrl, $g_hGUI)' & @CRLF & @CRLF & 'Return:' & @CRLF & Func CtrlMove(ByRef $g_aCtrls, $iCtrl, $g_hGUI)) ;### Debug MSGBOX

 

.

 

Edited by nitekram

All by me:

"Sometimes you have to go back to where you started, to get to where you want to go." 

"Everybody catches up with everyone, eventually" 

"As you teach others, you are really teaching yourself."

From my dad

"Do not worry about yesterday, as the only thing that you can control is tomorrow."

 

WindowsError.gif

WIKI | Tabs; | Arrays; | Strings | Wiki Arrays | How to ask a Question | Forum Search | FAQ | Tutorials | Original FAQ | ONLINE HELP | UDF's Wiki | AutoIt PDF

AutoIt Snippets | Multple Guis | Interrupting a running function | Another Send

StringRegExp | StringRegExp Help | RegEXTester | REG TUTOR | Reg TUTOT 2

AutoItSetOption | Macros | AutoIt Snippets | Wrapper | Autoit  Docs

SCITE | SciteJump | BB | MyTopics | Programming | UDFs | AutoIt 123 | UDFs Form | UDF

Learning to script | Tutorials | Documentation | IE.AU3 | Games? | FreeSoftware | Path_Online | Core Language

Programming Tips

Excel Changes

ControlHover.UDF

GDI_Plus

Draw_On_Screen

GDI Basics

GDI_More_Basics

GDI Rotate

GDI Graph

GDI  CheckExistingItems

GDI Trajectory

Replace $ghGDIPDll with $__g_hGDIPDll

DLL 101?

Array via Object

GDI Swimlane

GDI Plus French 101 Site

GDI Examples UEZ

GDI Basic Clock

GDI Detection

Ternary operator

Share this post


Link to post
Share on other sites

 

Ctrl+Shift+D = debug, messagebox

Alt+D = debug, console

 

EDIT

I get this for messagebox

MsgBox(262144, 'Debug line ~' & @ScriptLineNumber, 'Selection:' & @CRLF & 'Func' & @CRLF & @CRLF & 'Return:' & @CRLF & Func)

Are you supposed to enter Function name?

 

You are supposed to put your caret on a variable or actual function and then press Alt+D

Jos


Visit the SciTE4AutoIt3 Download page for the latest versions  - Beta files                                How to post scriptsource        Forum Rules
 
Live for the present,
Dream of the future,
Learn from the past.
  :)

Share this post


Link to post
Share on other sites

#7 ·  Posted (edited)

Now I get it - thanks again for whomever thought like I did lol

 

EDIT

By the way, this is going to make me a faster coder lol

Edited by nitekram

All by me:

"Sometimes you have to go back to where you started, to get to where you want to go." 

"Everybody catches up with everyone, eventually" 

"As you teach others, you are really teaching yourself."

From my dad

"Do not worry about yesterday, as the only thing that you can control is tomorrow."

 

WindowsError.gif

WIKI | Tabs; | Arrays; | Strings | Wiki Arrays | How to ask a Question | Forum Search | FAQ | Tutorials | Original FAQ | ONLINE HELP | UDF's Wiki | AutoIt PDF

AutoIt Snippets | Multple Guis | Interrupting a running function | Another Send

StringRegExp | StringRegExp Help | RegEXTester | REG TUTOR | Reg TUTOT 2

AutoItSetOption | Macros | AutoIt Snippets | Wrapper | Autoit  Docs

SCITE | SciteJump | BB | MyTopics | Programming | UDFs | AutoIt 123 | UDFs Form | UDF

Learning to script | Tutorials | Documentation | IE.AU3 | Games? | FreeSoftware | Path_Online | Core Language

Programming Tips

Excel Changes

ControlHover.UDF

GDI_Plus

Draw_On_Screen

GDI Basics

GDI_More_Basics

GDI Rotate

GDI Graph

GDI  CheckExistingItems

GDI Trajectory

Replace $ghGDIPDll with $__g_hGDIPDll

DLL 101?

Array via Object

GDI Swimlane

GDI Plus French 101 Site

GDI Examples UEZ

GDI Basic Clock

GDI Detection

Ternary operator

Share this post


Link to post
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

  • Similar Content

    • cosmos
      By cosmos
      Edit: Just realised this was posted in the wrong forum! I guess the Mods will move it to either "AutoIt General Help and Support" or "AutoIt Technical Discussion".
      Do you use type checking? Or do you choose not to type check?
      I was trying to think of the simplest way to do a type check without typing arguments more than once and I came up with:
      Func displayPerson($firstName, $lastName, $age) ; -- TYPE CHECK -- Local $typeCheck = ("" _ & IsString($firstName) _ & IsString($lastName) _ & IsNumber($age) _ ) If (StringInStr($typeCheck, "0")) Then MsgBox(16, "Type Error: displayPerson()", $typeCheck) ; -- FUNCTION -- MsgBox(0, "", $firstName & " " & $lastName & " (" & $age & ")") EndFunc The only catch with this method is that it produces a very simplistic error message. Even still, the fact that you only have to type out arguments once makes it a reasonable approach, in my opinion. The same logic can also be used for making function contracts (for example: $firstName mustn't be an empty string etc...).
      What do you think? How do you go about such things?
    • IamKJ
      By IamKJ
      I am trying to allow the GUI to gather info as to when to execute a function.  I am having trouble doing this.  So far this is what I have.
       
      ;Timer Func timer () If Not IsDeclared("iMsgBoxAnswer") Then Local $iMsgBoxAnswer $iMsgBoxAnswer = MsgBox(36,"Timer","Please format your answer in 00:00:00:000") Select Case $iMsgBoxAnswer = 6 ;Yes Global $infotime = InputBox ('Time', 'What time to execute?') Do $rawtimer = ToolTip(@Hour & ':' & @Min & ':' & @Sec & ':' & _MSec()) until $rawtimer = $infotime if $rawtimer = $infotime Then msgbox (0,'Worked','Worked') Else EndIf Case $iMsgBoxAnswer = 7 ;No Exit EndSelect EndFunc Func _MSec() Local $stSystemTime = DllStructCreate('ushort;ushort;ushort;ushort;ushort;ushort;ushort;ushort') DllCall('kernel32.dll', 'none', 'GetSystemTime', 'ptr', DllStructGetPtr($stSystemTime)) $sMilliSeconds = StringFormat('%03d', DllStructGetData($stSystemTime, 8)) $stSystemTime = 0 Return $sMilliSeconds EndFunc I have also tried _GUIToolTip_GetText in order to read the tooltip until the time specified, but it still doesn't work.  Any help would be great.
    • Jos
      By Jos
      Merged the SciTE 3.7.3 source into our version and several other changes and fixes to the supporting utilities.
      Enjoy,
      Jos
      Addition/Changes/Fixes in the current installer:
      -------------------------------------------------------------------------------------------------- 24-2-2017 *** Merged the SciTE v 3.7.3 by Neil Hodgson with our own version of SciTE. (Jos) *** Updated AutoIt3Wrapper v17.224.935.0 (Jos)     - 16.612.1119.1 Fixed #AutoIt3Wrapper_Run_Stop_OnError=N, avoiding to stop even when No or not  specified.     - 16.612.1119.2 Fixed #AutoIt3Wrapper_Run_Stop_OnError=N, avoiding to stop even when No or not  specified.     - 16.612.1119.3 Added warning for #AutoIt3Wrapper_UseX64 in case #pragma(out,..)  is used. *** Updated Au3Stripper v17.224.935.0 (Jos)     - 16.612.1119.1 Fixed issue which sometimes was stripping a global const incorrectly     - 16.612.1119.2 Fixed /maxiterations parameter not recognised     - 16.612.1119.3 Fixed increased the max #Au3Stripper_Ignore_Variables to 500 and for #Au3Stripper_Ignore_Funcs to 200     - 16.612.1119.4 Fixed regression introduced in 16.612.1119.1 *** Updated SciTEConfig v17.224.935.0 (Jos)     - 16.306.1119.1 ... *** Updated Tidy v17.224.935.0 (Jos)     - 16.612.1119.1: Fixed Sort_Func function bug when the source contains a BOM. *** Updated CodewiZard v1.5.4.0 (Cyberyeye)     - Fix Icon Ressource Number for Messagebox Tab & ToolTip Tab     - Check/Fix missing includes using AutoIt3Wrapper_Add_Constants=y     - Added Opt("MustDeclareVars", 1) to fix undeclared variables     - Replaced msgbox() magic number by constant name     - Added GUISetIcon var (au3.ico)     - Removed unusefull old AutoIt3Wrapper directive *** Updated Abbreviations (mLipok)     - Updated au3abbrev.properties and helpfile page. --------------------------------------------------------------------------------------------------
      ==> ScitillaHistory page containing all SciTE-Scintilla updates.
      ==> Visit the SciTE4AutoIt3 Download page for the latest versions
      ==> Check  the online documentation for an overview of all extra's you get with this installer.
       
    • XOblivion
      By XOblivion
      im some what new to autoit and need help figuring out best way to make a simple clicker for few idle games i play(taptitdue, sakura clicker, elndless frontier etc.) ive played around with autoit recorder to make simple copy mouse clicks. but now i want to make a script that allows me to select multiple functions before starting the script for game ex: click section A or click section A + B to run At set intervals if that makes sense . i dont need scripts made by other just info on what things i should use to make it my self.
       
      need to be able to select between games and be able to select multiple functions to run inconjuntion or independent for each game. thank you in advance
    • odaylton
      By odaylton
      Text translated from Portuguese by google - please apologize for any errors
      After using the first 15 lines are replaced
      I'm using autoitdebug and made the new update installation of v3.3.14.2 autoit
      And Tidy AutoIt3 v2.3.0.8 Copyright (c) Jos van der Zande March 24, 2013
      After using it incere 15 lines containing:
      e|_WinNet_GetUser|_WinNet_OpenEnum|_WinNet_RestoreConnection|_WinNet_UseConnection|_Word_Create|_Word_DocAdd|_Word_DocAttach|_Word_DocClose|_Word_DocExport|_Word_DocFind|_Word_DocFindReplace|_Word_DocGet|_Word_DocLinkAdd|_Word_DocLinkGet|_Word_DocOpen|_Word_DocPictureAdd|_Word_DocPrint|_Word_DocRangeSet|_Word_DocSave|_Word_DocSaveAs|_Word_DocTableRead|_Word_DocTableWrite|_Word_Quit|
      num|_WinNet_RestoreConnection|_WinNet_UseConnection|_Word_Create|_Word_DocAdd|_Word_DocAttach|_Word_DocClose|_Word_DocExport|_Word_DocFind|_Word_DocFindReplace|_Word_DocGet|_Word_DocLinkAdd|_Word_DocLinkGet|_Word_DocOpen|_Word_DocPictureAdd|_Word_DocPrint|_Word_DocRangeSet|_Word_DocSave|_Word_DocSaveAs|_Word_DocTableRead|_Word_DocTableWrite|_Word_Quit|
      DocAttach|_Word_DocClose|_Word_DocExport|_Word_DocFind|_Word_DocFindReplace|_Word_DocGet|_Word_DocLinkAdd|_Word_DocLinkGet|_Word_DocOpen|_Word_DocPictureAdd|_Word_DocPrint|_Word_DocRangeSet|_Word_DocSave|_Word_DocSaveAs|_Word_DocTableRead|_Word_DocTableWrite|_Word_Quit|
      d|_Word_DocFindReplace|_Word_DocGet|_Word_DocLinkAdd|_Word_DocLinkGet|_Word_DocOpen|_Word_DocPictureAdd|_Word_DocPrint|_Word_DocRangeSet|_Word_DocSave|_Word_DocSaveAs|_Word_DocTableRead|_Word_DocTableWrite|_Word_Quit|
      Get|_Word_DocLinkAdd|_Word_DocLinkGet|_Word_DocOpen|_Word_DocPictureAdd|_Word_DocPrint|_Word_DocRangeSet|_Word_DocSave|_Word_DocSaveAs|_Word_DocTableRead|_Word_DocTableWrite|_Word_Quit|
      t|_Word_DocLinkAdd|_Word_DocLinkGet|_Word_DocOpen|_Word_DocPictureAdd|_Word_DocPrint|_Word_DocRangeSet|_Word_DocSave|_Word_DocSaveAs|_Word_DocTableRead|_Word_DocTableWrite|_Word_Quit|
      _Word_DocLinkAdd|_Word_DocLinkGet|_Word_DocOpen|_Word_DocPictureAdd|_Word_DocPrint|_Word_DocRangeSet|_Word_DocSave|_Word_DocSaveAs|_Word_DocTableRead|_Word_DocTableWrite|_Word_Quit|
      ureAdd|_Word_DocPrint|_Word_DocRangeSet|_Word_DocSave|_Word_DocSaveAs|_Word_DocTableRead|_Word_DocTableWrite|_Word_Quit|
      angeSet|_Word_DocSave|_Word_DocSaveAs|_Word_DocTableRead|_Word_DocTableWrite|_Word_Quit|
       
      Replacing my script
      What went wrong