2 Code Requirements
PrincipalSpears edited this page 2021-07-29 17:28:43 +00:00
  • If something you write isn't easily understandable to a noobie, please document it or get someone else to. Since SnootGame is an amneture project, we'd like to keep it friendly to amnetures. Post links to non-technical explinations of what obscure pieces of code do, explain what certain althorithms are and how they work, and over all just make sure that even a codelet could understand what something does by reading the comments.
  • Try your best to not make code look ugly. Ugly code is a pain to read and makes life harder, please avoid it when you can. If its simply not possible, then do document what is happening.
  • Code should be maintainable by others, modular, hackable, and, if need be, able to be used as a template. This is to allow easy debugging, easy code reuse, and ease of maintanace for when things eventually break. Avoid spaghetti when possible.
  • Typical coding convention of sane variable names go with it too. Abbrevations are acceptable if their point is obvious, but its always nice to have a full name for something. Most variables are wrote in camelCase, conform to this whenever possible.