Best coding practices - Revision history

Water: Enhanced examples

2020-10-29T09:56:13Z

Enhanced examples

← Older revision		Revision as of 09:56, 29 October 2020
Line 410:		Line 410:
	; Not recommended		; Not recommended
	Local Const $hGUI = GUICreate("MyGUI")		Local Const $hGUI = GUICreate("MyGUI")
	; The handle of the window is unique, it's generated by Windows and changes		; The handle of the window is unique, it's generated by Windows and changes.
			; To be exact: It is constant for the lifetime of the currently running script. But when you run the script again you get a different handle from Windows.

	; Recommended		; Recommended
	Local Const $~~iMyAge~~ = 19		Local Const $fPi = 3.1415926 ; Archimedes' constant
	</syntaxhighlight>		</syntaxhighlight>

Water: Added prefix "o" for Objects

2019-10-17T09:26:55Z

Added prefix "o" for Objects

← Older revision		Revision as of 09:26, 17 October 2019
Line 37:		Line 37:
	\|-		\|-
	\| n \|\| General number (no preference) \|\| $nNumber = 0		\| n \|\| General number (no preference) \|\| $nNumber = 0
			\|-
			\| o \|\| Objects \|\| $oExcel = ObjCreate("Excel.Application")
	\|-		\|-
	\| p \|\| Pointers \|\| $pRect = DllStructGetPtr($tRECT)		\| p \|\| Pointers \|\| $pRect = DllStructGetPtr($tRECT)
Line 495:		Line 497:
	The corrected example:		The corrected example:
	<syntaxhighlight lang="autoit">		<syntaxhighlight lang="autoit">
			#include <MsgBoxConstants.au3>
	MsgBox($MB_TOPMOST, "Magic Numbers", "It's Adventure Time!")		MsgBox($MB_TOPMOST, "Magic Numbers", "It's Adventure Time!")
	</syntaxhighlight>		</syntaxhighlight>

Mlazovjp: /* Enum */ Typo

2019-10-17T01:18:52Z

Enum: Typo

← Older revision		Revision as of 01:18, 17 October 2019
Line 465:		Line 465:

	; Sometimes using this approach for accessing an element is more practical than using a numerical value, due to the fact changing the index value of		; Sometimes using this approach for accessing an element is more practical than using a numerical value, due to the fact changing the index value of
	; the enum constant has no ~~affect~~ on its position in the array. Therefore changing the location of $eCat in the array is as simple as changing the order		; the enum constant has no effect on its position in the array. Therefore changing the location of $eCat in the array is as simple as changing the order
	; it appears in the initial declaration e.g		; it appears in the initial declaration e.g

Mlazovjp: /* Enum */

2019-10-17T01:17:32Z

Enum

← Older revision		Revision as of 01:17, 17 October 2019
Line 465:		Line 465:

	; Sometimes using this approach for accessing an element is more practical than using a numerical value, due to the fact changing the index value of		; Sometimes using this approach for accessing an element is more practical than using a numerical value, due to the fact changing the index value of
	; the enum constant has no affect on ~~it's~~ position in the array. Therefore changing the location of $eCat in the array is as simple as changing the order		; the enum constant has no affect on its position in the array. Therefore changing the location of $eCat in the array is as simple as changing the order
	; it appears in the initial declaration e.g		; it appears in the initial declaration e.g

Mlazovjp: /* Scopes of Variables */ Minor typos and punctuation

2019-10-16T23:37:59Z

Scopes of Variables: Minor typos and punctuation

← Older revision		Revision as of 23:37, 16 October 2019
Line 175:		Line 175:
	* A variable declared globally (with the Global keyword) is visible anywhere in the script.<br />Always declare your global variables in the global scope, not in a function. It will prevent another function from using it before its declaration and the declaration is implicit (see [[#jumpsec1\|examples]]).		* A variable declared globally (with the Global keyword) is visible anywhere in the script.<br />Always declare your global variables in the global scope, not in a function. It will prevent another function from using it before its declaration and the declaration is implicit (see [[#jumpsec1\|examples]]).

	* A variable declared locally (with the Local keyword), has a visibility which depends of the scope where it's declared.		* A variable declared locally (with the Local keyword), has a visibility which depends on the scope where it's declared.
	:Declaration in the global scope: the variable is visible everywhere; declare it as Local if this one is only to be used in the same scope, i.e. outside of any functions. A variable declared as Local in the Global scope is still a Global variable, it's only for the sake of code clarity that you'd use the Local declaration in the Global scope.		:Declaration in the global scope: the variable is visible everywhere; declare it as Local if this one is only to be used in the same scope, i.e. outside of any functions. A variable declared as Local in the Global scope is still a Global variable, it's only for the sake of code clarity that you'd use the Local declaration in the Global scope.
	:Declaration in a function: the variable is visible by the function itself and nowhere else.		:Declaration in a function: the variable is visible by the function itself and nowhere else.
Line 191:		Line 191:
	Global $g_iVar1 = 0		Global $g_iVar1 = 0

	; Assign a Local variable the string "foo", its scope is Local because ~~it's~~ use is used only in this scope		; Assign a Local variable the string "foo", its scope is Local because its use is used only in this scope
	Local $sVar2 = "foo"		Local $sVar2 = "foo"

Line 210:		Line 210:
	MsgBox($MB_SYSTEMMODAL, "", "Value of $g_iVar1: " & $g_iVar1)		MsgBox($MB_SYSTEMMODAL, "", "Value of $g_iVar1: " & $g_iVar1)

	; Assign a Local variable the string "bar", its scope is Local because ~~it's~~ use is restricted to the function's scope		; Assign a Local variable the string "bar", its scope is Local because its use is restricted to the function's scope
	Local $sVar3 = "bar"		Local $sVar3 = "bar"

Line 229:		Line 229:

	; Assign a Local variable an array containing numbers with a size of 5		; Assign a Local variable an array containing numbers with a size of 5
	; Note ~~than~~ an array is 0 based, to access the first element the code is: $aiArray[0]		; Note that an array is 0 based, so to access the first element the code is: $aiArray[0]
	Local $aiArray[5] = [1, 2, 3, 4, 5]		Local $aiArray[5] = [1, 2, 3, 4, 5]

Line 272:		Line 272:

	; Assign a Local variable an array containing numbers with a size of 5		; Assign a Local variable an array containing numbers with a size of 5
	; Note than an array is 0 based, to access the first element the code is: $aiArray[0]		; Note than an array is 0 based, so to access the first element the code is: $aiArray[0]
	Local $aArray[5] = [1, 2, 3, 4, 5]		Local $aArray[5] = [1, 2, 3, 4, 5]

MLipok: Added link to forum discussion

2018-02-14T09:45:40Z

Added link to forum discussion

← Older revision		Revision as of 09:45, 14 February 2018
Line 567:		Line 567:
	#include-once		#include-once
	</syntaxhighlight>		</syntaxhighlight>

			For discussion please visit: [http://www.autoitscript.com/forum/index.php?showtopic=146866 Forum: Good coding practices in AutoIt]

MLipok: Best >> Good

2017-11-04T22:12:12Z

Best >> Good

← Older revision		Revision as of 22:12, 4 November 2017
Line 1:		Line 1:
	Outlined in this section is a detailed explanation of what are to be considered the ~~best~~ coding practices within AutoIt. These recommendations are based on accepted coding practices common to a number of other programming languages. You do not need to follow them, but it is recommended that you do.		Outlined in this section is a detailed explanation of what are to be considered the good coding practices within AutoIt. These recommendations are based on accepted coding practices common to a number of other programming languages. You do not need to follow them, but it is recommended that you do.

	'''Note''': You must use AutoIt v3.3.10.0 or above to run the examples below.		'''Note''': You must use AutoIt v3.3.10.0 or above to run the examples below.

BrewManNH: /* Include-once directive */

2016-07-20T20:27:30Z

Include-once directive

← Older revision		Revision as of 20:27, 20 July 2016
Line 558:		Line 558:

	== Include-once directive ==		== Include-once directive ==
	This one is designed for standard includes and UDFs, it's highly recommended to use it.		This one is designed for standard includes and UDFs, it's highly recommended to use it only for that.

	Those includes may be ~~included~~ in more than one ~~script~~ of your project because they are needed for some includes or your script itself.		Those includes may be used in more than one file of your project because they are needed for some includes or your script itself.
	In that case, the code ~~will~~ be duplicated which is not a good thing especially if you have ~~(and it's mainly the case)~~ constants declared in those files, in so far as the constants cannot be redeclared/reassigned; same thing for functions		In that case, the code would be duplicated, which is not a good thing especially if you have constants declared in those files, in so far as the constants cannot be redeclared/reassigned you will get error messages about trying to redeclare them; same thing for functions, you can't use a function name more than once.

	Put the directive in top of your UDF (library) to avoid ~~itself to be~~ included more than once :		Put the directive at the top of your UDF (library) to avoid it from being included more than once :
	<syntaxhighlight lang="autoit">		<syntaxhighlight lang="autoit">
	#include-once		#include-once
	</syntaxhighlight>		</syntaxhighlight>

BrewManNH: /* Magic Numbers */

2016-07-20T20:22:52Z

Magic Numbers

← Older revision		Revision as of 20:22, 20 July 2016
Line 546:		Line 546:

	Case $GUI_EVENT_MINIMIZE, $GUI_EVENT_RESTORE ; Better, this is documented in the help file		Case $GUI_EVENT_MINIMIZE, $GUI_EVENT_RESTORE ; Better, this is documented in the help file
	MsgBox($MB_SYSTEMMODAL, '', 'Do something when this action takes place.') ~~; Better, this is documented in the help file~~		MsgBox($MB_SYSTEMMODAL, '', 'Do something when this action takes place.')

	EndSwitch		EndSwitch

BrewManNH: /* Au3Check directive */

2016-07-20T20:21:00Z

Au3Check directive

← Older revision		Revision as of 20:21, 20 July 2016
Line 482:		Line 482:
	#AutoIt3Wrapper_Au3Check_Parameters=-q -d -w 1 -w 2 -w 3 -w- 4 -w 5 -w 6 -w- 7		#AutoIt3Wrapper_Au3Check_Parameters=-q -d -w 1 -w 2 -w 3 -w- 4 -w 5 -w 6 -w- 7
	</syntaxhighlight>		</syntaxhighlight>
			\|Note: this directive is only used if you've installed the full version of [https://www.autoitscript.com/cgi-bin/getfile.pl?../autoit3/scite/download/SciTE4AutoIt3.exe Scite4AutoIt3]

	== Magic Numbers ==		== Magic Numbers ==