Lou Montana/Sandbox – User
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Add X39's link for future reference) |
m (→Make it readable: var names) |
||
| Line 16: | Line 16: | ||
{{Informative | See [[Code Optimisation#Make it readable|Make it readable]] for the short version!}} | {{Informative | See [[Code Optimisation#Make it readable|Make it readable]] for the short version!}} | ||
* Some general coding tips from [https://www.topcoder.com/blog/coding-best-practices/ here]: standards, line lengths, etc | * Some general coding tips from [https://www.topcoder.com/blog/coding-best-practices/ here]: standards, line lengths, etc | ||
** | ** Variable names should indicate what they store / are used for. | ||
;Example: | |||
<code>{{cc|Instead of}} | |||
[[private]] _cd = 360; | |||
{{cc|do}} | |||
[[private]] _countDown = 360;</code> | |||
** Format, indentation, no one-line, spacing, line returns | ** Format, indentation, no one-line, spacing, line returns | ||
** Be consistent (space/tab indentation, (camel)casing, [https://en.wikipedia.org/wiki/Indentation_style#K&R_style K&R style] / [https://en.wikipedia.org/wiki/Indentation_style#Allman_style Allman style] indenting) | ** Be consistent (space/tab indentation, (camel)casing, [https://en.wikipedia.org/wiki/Indentation_style#K&R_style K&R style] / [https://en.wikipedia.org/wiki/Indentation_style#Allman_style Allman style] indenting) | ||
Revision as of 01:22, 6 September 2019
Best practices
Make it readable
- Some general coding tips from here: standards, line lengths, etc
- Variable names should indicate what they store / are used for.
- Example
// Instead of
private _cd = 360;
// do
private _countDown = 360;
- Format, indentation, no one-line, spacing, line returns
- Be consistent (space/tab indentation, (camel)casing, K&R style / Allman style indenting)
Make reusable functions
- Don't duplicate, make functions
Variables
- Prefix your public variables and setVariable with your tag
- PRIVATE (or params) your variables
- Use #define SOME_CONST for constant values instead of variables
Code location
- Nothing in init box but local commands for this specific unit - all the init boxes are run client-side on client connection
0 = myCommandis "useful" only for editor fields that for no apparent reason refuse commands returning a value.
Final words
- Don't steal code and pretend it's yours — be a decent human being.
- Don't try to obfuscate your code: it's considered rude, especially since you learnt from others.
- Have fun!