Lou Montana/Sandbox – User

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Small update - WIP)
m (linked indentation styles wiki page)
Line 1: Line 1:
[[Category: Sandbox]]
[[Category: Sandbox]]
[[:Category: Scripting Topics]]
{{Informative | Future [[Code Best Practices]] page}}
{{Informative | Future [[Code Best Practices]] page}}
----
----
[[:Category: Scripting Topics]]
;Best practices:
== Best practices ==
* [[Code Optimisation#Make it readable|Make it readable]]
 
** var names
=== Make it readable ===
** format, indentation, no one-line, spacing, line returns
 
** Be consistent (space/tab indentation, (camel)casing, K&R / Allman style indenting. See [https://en.wikipedia.org/wiki/Indentation_style#K&R_style Indentation Styles])
{{Informative | See [[Code Optimisation#Make it readable|Make it readable]] for the short version!}}
 
** Var names
** 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)
 
=== Make reusable functions ===
 
* Don't duplicate, make functions
* Don't duplicate, make functions
 
* prefix your public variables with your tag
=== Variables ===
 
* Prefix your public variables with your tag
* PRIVATE (or params) your variables
* PRIVATE (or params) your variables


=== Code location ===
;Also:
 
* don't steal code and pretend it's yours
* '''Nothing''' in init box ''but'' [[local]] commands for this specific unit - '''all''' the init boxes are run client-side on client connection
* don't try to obfuscate your code: it's considered rude, especially since you learnt from others
* {{Inline code|'''0 {{=}}''' ''myCommand''}} is "useful" only for editor fields that for no apparent reason refuse commands returning a value.
* have fun
 
 
== 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!

Revision as of 18:42, 5 September 2019

Category: Scripting Topics

ⓘ
Best practices
  • Make it readable
    • var names
    • format, indentation, no one-line, spacing, line returns
    • Be consistent (space/tab indentation, (camel)casing, K&R / Allman style indenting. See Indentation Styles)
  • Don't duplicate, make functions
  • prefix your public variables with your tag
  • PRIVATE (or params) your variables
Also
  • don't steal code and pretend it's yours
  • don't try to obfuscate your code: it's considered rude, especially since you learnt from others
  • have fun
Retrieved from "https://community.bistudio.com/wiki?title=User:Lou_Montana/Sandbox&oldid=136919"