Skip to content

Code Standards

LightenDarkness edited this page Sep 19, 2022 · 11 revisions

Coding Standards

Casing

Class - PascalCase
Constants - MACRO_CASE
Functions - camelCase
Global Variables - camelCase
Local Variables - camelCase

Comments

Javadocs will be used for class and function comments.

/**
* Describe the method here
* @param numA Describe param by this name
* @param numB Describe another param
* @return type This returns something
*/

Clone this wiki locally