Code Standards

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.

Function Comment:

/**
* Describe the method
* Second line describing method
* @param numA Describe param by this name
* @param numB Describe another param
* @return int This returns something
*/

Class Comment:

/**
* Class description
* additional info
*/