Code Best Practices - Revision history

Lou Montana: Text replacement - "{{Link|:Category:" to "{{Link|Category:"

2024-10-16T13:51:56Z

Text replacement - "{{Link|:Category:" to "{{Link|Category:"

← Older revision		Revision as of 15:51, 16 October 2024
Line 11:		Line 11:
	=== Prerequisites ===		=== Prerequisites ===

	* An advanced text editor such as Visual Studio Code or Notepad++ - see {{Link\|:Category:Community Tools#Code Edition}} for useful tools and plugins		* An advanced text editor such as Visual Studio Code or Notepad++ - see {{Link\|Category:Community Tools#Code Edition}} for useful tools and plugins
	* Some English knowledge, helped if needed by a translator tool such as {{Link\|https://www.google.com/translate\|Google Translate}} or {{Link\|https://www.deepl.com/\|DeepL}}		* Some English knowledge, helped if needed by a translator tool such as {{Link\|https://www.google.com/translate\|Google Translate}} or {{Link\|https://www.deepl.com/\|DeepL}}
	* Access to this wiki is a plus (the Swiss flag is, too)		* Access to this wiki is a plus (the Swiss flag is, too)

Lou Montana: Some wiki formatting

2024-05-17T09:46:43Z

Some wiki formatting

← Older revision		Revision as of 11:46, 17 May 2024
Line 1:		Line 1:
	{{TOC\|side}}		{{TOC\|side}}
	== Getting ~~started~~ ==		== Getting Started ==

	In the domain of development, any rule is a rule of thumb.		In the domain of development, any rule is a rule of thumb.
Line 19:		Line 19:


	== Best ~~practices~~ ==		== Best Practices ==

	=== Code ~~format~~ ===		=== Code Format ===

	* Whatever you do about your code's format, '''be consistent'''.		* Whatever you do about your code's format, '''be consistent'''.
Line 33:		Line 33:
	* {{hl\|1= <span style="background-color: #FCC">'''0 =''' </span>''myCommand''}} '''was''' "useful" only for editor fields that for no apparent reason refused commands returning a value. You do '''not''' need it in script files, and don't need it in editor fields anymore '''since {{arma3}} v2.04'''.		* {{hl\|1= <span style="background-color: #FCC">'''0 =''' </span>''myCommand''}} '''was''' "useful" only for editor fields that for no apparent reason refused commands returning a value. You do '''not''' need it in script files, and don't need it in editor fields anymore '''since {{arma3}} v2.04'''.

	=== Variable ~~format~~ ===		=== Variable Format ===

	* Name your variables and functions properly:<!--		* Name your variables and functions properly:<!--
Line 44:		Line 44:
	* Defined constants must be UPPERCASE_WITH_UNDERSCORES (e.g <sqf inline>#define SOME_CONST</sqf>).		* Defined constants must be UPPERCASE_WITH_UNDERSCORES (e.g <sqf inline>#define SOME_CONST</sqf>).

			=== Code Structuration ===
	=== Code ~~structuration~~ ===

	* '''DRY:''' '''D'''on't '''R'''epeat '''Y'''ourself. If you write the same code block or the same logic many times, export this code as a function and use parameters with it.		* '''DRY:''' '''D'''on't '''R'''epeat '''Y'''ourself. If you write the same code block or the same logic many times, export this code as a function and use parameters with it.
Line 53:		Line 52:
	--> Your code organisation combined to your variable names must be enough to be read by a human.		--> Your code organisation combined to your variable names must be enough to be read by a human.

	=== Code/Files ~~organisation~~ ===		=== Code/Files Organisation ===

	* Use [[Arma 3: Functions Library#Adding a Function\|CfgFunctions]] to declare the functions that will be called frequently.		* Use [[Arma 3: Functions Library#Adding a Function\|CfgFunctions]] to declare the functions that will be called frequently.
Line 64:		Line 63:
	<!--		<!--

	EDITOR'S NOTE: Formatting Code examples are not linking commands on purpose! This allows for a fair comparison of both syntaxes' readability.		EDITOR'S NOTE: Formatting Code examples are not linking commands on purpose! This allows for a fair comparison of both syntaxes's readability.

	-->		-->
Line 242:		Line 241:


	== Final ~~words~~ ==		== Final Words ==

	* Remember: '''consistency''' is the most important thing!		* Remember: '''consistency''' is the most important thing!
	* The {{arma}} Discord server and its community can help: {{Link\|https://discord.gg/arma\|ARMA}} (channel {{hl\|#arma3_scripting}})		* The {{arma}} Discord server and its community can help: {{Link\|https://discord.gg/arma\|ARMA}} (channel {{hl\|#arma3_scripting}})
	* Learn from others' scripts but ~~don't~~ steal code and pretend it is yours — be a decent human being. Stealing code and its consequences:		* Learn from others's scripts but do not steal code and pretend it is yours — be a decent human being. Stealing code and its consequences:
	** It soils your reputation and devaluates your actions once it is found out — and it ''always'' get found out. DMCA's are filled on Steam every day.		** It soils your reputation and devaluates your actions once it is found out — and it ''always'' get found out. DMCA's are filled on Steam every day.
	** It makes people in the community get less helpful and more reluctant in giving advices. It can also prevent them to ''release'' an interesting feature!		** It makes people in the community get less helpful and more reluctant in giving advices. It can also prevent them to ''release'' an interesting feature!
Line 252:		Line 251:
	** Obfuscated code only makes it ''harder'' to get, but does not make it ''copy-protected''. If the engine can read it, it can be obtained.		** Obfuscated code only makes it ''harder'' to get, but does not make it ''copy-protected''. If the engine can read it, it can be obtained.
	** Obfuscated code is also slower on parsing and, depending on the quality of code and obfuscation, on execution too.		** Obfuscated code is also slower on parsing and, depending on the quality of code and obfuscation, on execution too.
	* Do not hesitate to help newcomers even if you ~~don't~~ know the whole topic: both sides will learn from it!		* Do not hesitate to help newcomers even if you do not know the whole topic: both sides will learn from it!
	* Most important of all, have fun!		* Most important of all, have fun!

Lou Montana: Fix link

2024-05-16T17:05:21Z

Fix link

← Older revision		Revision as of 19:05, 16 May 2024
Line 259:		Line 259:

	* [[Code Optimisation]]		* [[Code Optimisation]]
	* [[~~Writing_sqf_without_negation~~]]		* [[Code Positivity]]
	* [[Mission Optimisation]]		* [[Mission Optimisation]]
	* [[Multiplayer Scripting]]		* [[Multiplayer Scripting]]

Lou Montana: Text replacement - "[[Arma 3 " to "[[Arma 3: "

2024-05-06T09:38:14Z

Text replacement - "[[Arma 3 " to "[[Arma 3: "

← Older revision		Revision as of 11:38, 6 May 2024
Line 55:		Line 55:
	=== Code/Files organisation ===		=== Code/Files organisation ===

	* Use [[Arma 3 Functions Library#Adding a Function\|CfgFunctions]] to declare the functions that will be called frequently.		* Use [[Arma 3: Functions Library#Adding a Function\|CfgFunctions]] to declare the functions that will be called frequently.
	** One Functions directory, with sub-directories if needed.		** One Functions directory, with sub-directories if needed.
	* Use [[Event Scripts]] as needed.		* Use [[Event Scripts]] as needed.

Nelis75733126: added a 'see also' link to newly created page.

2024-05-04T21:31:52Z

added a 'see also' link to newly created page.

← Older revision		Revision as of 23:31, 4 May 2024
Line 259:		Line 259:

	* [[Code Optimisation]]		* [[Code Optimisation]]
			* [[Writing_sqf_without_negation]]
	* [[Mission Optimisation]]		* [[Mission Optimisation]]
	* [[Multiplayer Scripting]]		* [[Multiplayer Scripting]]

Lou Montana: Text replacement - "\[ (https?:\/\/[^ = ]+) +([^= ]+) \]" to "{{Link|$1|$2}}"

2023-04-28T14:08:50Z

Text replacement - "\[ *(https?:\/\/[^ = ]+) +([^= ]+) *\]" to "{{Link|$1|$2}}"

← Older revision		Revision as of 16:08, 28 April 2023
Line 12:		Line 12:

	* An advanced text editor such as Visual Studio Code or Notepad++ - see {{Link\|:Category:Community Tools#Code Edition}} for useful tools and plugins		* An advanced text editor such as Visual Studio Code or Notepad++ - see {{Link\|:Category:Community Tools#Code Edition}} for useful tools and plugins
	* Some English knowledge, helped if needed by a translator tool such as [https://www.google.com/translate Google Translate] or [https://www.deepl.com/ DeepL]		* Some English knowledge, helped if needed by a translator tool such as {{Link\|https://www.google.com/translate\|Google Translate}} or {{Link\|https://www.deepl.com/\|DeepL}}
	* Access to this wiki is a plus (the Swiss flag is, too)		* Access to this wiki is a plus (the Swiss flag is, too)
	* Tutorials/examples (YouTube tutorials, community tutorials, [[:Category:Example_Code\|Example Code]])		* Tutorials/examples (YouTube tutorials, community tutorials, [[:Category:Example_Code\|Example Code]])
	* Google-Fu (a.k.a search engine skills)		* Google-Fu (a.k.a search engine skills)
	* {{arma}} Discord server: [https://discord.gg/arma ARMA], channel {{hl\|#arma3_scripting}}		* {{arma}} Discord server: {{Link\|https://discord.gg/arma\|ARMA}}, channel {{hl\|#arma3_scripting}}


Line 245:		Line 245:

	* Remember: '''consistency''' is the most important thing!		* Remember: '''consistency''' is the most important thing!
	* The {{arma}} Discord server and its community can help: [https://discord.gg/arma ARMA] (channel {{hl\|#arma3_scripting}})		* The {{arma}} Discord server and its community can help: {{Link\|https://discord.gg/arma\|ARMA}} (channel {{hl\|#arma3_scripting}})
	* Learn from others' scripts but don't steal code and pretend it is yours — be a decent human being. Stealing code and its consequences:		* Learn from others' scripts but don't steal code and pretend it is yours — be a decent human being. Stealing code and its consequences:
	** It soils your reputation and devaluates your actions once it is found out — and it ''always'' get found out. DMCA's are filled on Steam every day.		** It soils your reputation and devaluates your actions once it is found out — and it ''always'' get found out. DMCA's are filled on Steam every day.

Lou Montana: Add hadouken highlight

2023-04-18T11:37:20Z

Add hadouken highlight

← Older revision		Revision as of 13:37, 18 April 2023
Line 195:		Line 195:
	// hadouken code		// hadouken code
	}		}
	else { /* failure 3 */ };		else { {{codecomment\|/* failure 3 */}} };
	}		}
	else { /* failure 2 */ };		else { {{codecomment\|/* failure 2 */}} };
	}		}
	else { /* failure 1 */ };		else { {{codecomment\|/* failure 1 */}} };
	\|		\|
	if (!cond1) exitWith { /* failure 1 */ };		if (!cond1) exitWith { {{codecomment\|/* failure 1 */}} };
	if (!cond2) exitWith { /* failure 2 */ };		if (!cond2) exitWith { {{codecomment\|/* failure 2 */}} };
	if (!cond3) exitWith { /* failure 3 */ };		if (!cond3) exitWith { {{codecomment\|/* failure 3 */}} };

	// code		// code

Lou Montana: Some wiki formatting

2023-04-17T13:02:07Z

Some wiki formatting

← Older revision		Revision as of 15:02, 17 April 2023
Line 195:		Line 195:
	// hadouken code		// hadouken code
	}		}
	else { /* failure 3 */ }		else { /* failure 3 */ };
	}		}
	else { /* failure 2 */ }		else { /* failure 2 */ };
	}		}
	else { /* failure 1 */ };		else { /* failure 1 */ };
Line 253:		Line 253:
	** Obfuscated code is also slower on parsing and, depending on the quality of code and obfuscation, on execution too.		** Obfuscated code is also slower on parsing and, depending on the quality of code and obfuscation, on execution too.
	* Do not hesitate to help newcomers even if you don't know the whole topic: both sides will learn from it!		* Do not hesitate to help newcomers even if you don't know the whole topic: both sides will learn from it!
	* Most of all, have fun!		* Most important of all, have fun!

Lou Montana: Add code funneling

2023-04-17T13:01:26Z

Add code funneling

Show changes

Lou Montana: Fix Wikipedia link

2023-02-23T22:47:45Z

Fix Wikipedia link

← Older revision		Revision as of 00:47, 24 February 2023
Line 26:		Line 26:
	* Choose an indentation format '''and stick to it'''. There is not especially one indent better than another (''but there sure are terrible ones''), again the important point here being ''consistency''.		* Choose an indentation format '''and stick to it'''. There is not especially one indent better than another (''but there sure are terrible ones''), again the important point here being ''consistency''.
	** Common indentation styles are:		** Common indentation styles are:
	*** {{~~Wikipedia~~\|~~Indentation style~~#K&~~R style~~\|K&R style}} indenting		*** {{Link\|https://en.wikipedia.org/wiki/Indentation_style#K&R_style\|K&R style}} indenting
	*** {{~~Wikipedia~~\|~~Indentation style~~#~~Allman style~~\|Allman style}} indenting		*** {{Link\|https://en.wikipedia.org/wiki/Indentation_style#Allman_style\|Allman style}} indenting
	** Use empty space. Line return, spaces before and after brackets, if this improves readability, use it: space is free.		** Use empty space. Line return, spaces before and after brackets, if this improves readability, use it: space is free.
	** indent with two/four spaces '''or''' one tab. Do not mix these.		** indent with two/four spaces '''or''' one tab. Do not mix these.
Line 38:		Line 38:
	--> While [[SQF Syntax\|SQF]] ''is'' (non-noticeably) impacted by variable name length, this should not take precedence on the fact that code must be readable by a human being.		--> While [[SQF Syntax\|SQF]] ''is'' (non-noticeably) impacted by variable name length, this should not take precedence on the fact that code must be readable by a human being.
	** Your variable names must have a meaning: variables like '''_u''' instead of '''_uniform''' should not exist. '''_i''' is an accepted iteration variable name (e.g in [[for]] loops).		** Your variable names must have a meaning: variables like '''_u''' instead of '''_uniform''' should not exist. '''_i''' is an accepted iteration variable name (e.g in [[for]] loops).
	** It is recommended to use {{~~Wikipedia~~\|Camel_case\|camel-case}} your variables;<!--		** It is recommended to use {{Link\|https://en.wikipedia.org/wiki/Camel_case\|camel-case}} your variables;<!--
	--> camel-casing (namingLikeThis) your variables and functions make the code naturally more readable, especially for long names.		--> camel-casing (namingLikeThis) your variables and functions make the code naturally more readable, especially for long names.
	* Prefix your public variables and [[setVariable]] with your tag in order to avoid any conflict about other mods, scripts or mission variables.		* Prefix your public variables and [[setVariable]] with your tag in order to avoid any conflict about other mods, scripts or mission variables.

Code Best Practices - Revision history

Lou Montana: Text replacement - "{{Link|:Category:" to "{{Link|Category:"

Lou Montana: Some wiki formatting

Lou Montana: Fix link

Lou Montana: Text replacement - "[[Arma 3 " to "[[Arma 3: "

Nelis75733126: added a 'see also' link to newly created page.

Lou Montana: Text replacement - "\[ *(https?:\/\/[^ = ]+) +([^= ]+) *\]" to "{{Link|$1|$2}}"

Lou Montana: Add hadouken highlight

Lou Montana: Some wiki formatting

Lou Montana: Add code funneling

Lou Montana: Fix Wikipedia link

Lou Montana: Text replacement - "\[ (https?:\/\/[^ = ]+) +([^= ]+) \]" to "{{Link|$1|$2}}"