Skip to content

Conventions

Louis Lefevre edited this page May 31, 2020 · 1 revision

Conventions

Class Structure

  1. Variables
    a. Static variable declarations
    b. Instance variable declarations
  2. Static constructor
    a. Static variable initialisation
  3. Static methods
    a. Other static methods
    b. Static variable getters & setters
  4. Instance constructor
    b. Instance variable initialization
  5. Instance methods
    a. Other instance methods
    b. Instance variable getters & setters

Rules

i. All variables must be declared private, and any final variables come first in their corresponding section.
ii. Reference variables should be declared first, and primitive variables second.
iii. Setters and getters should be ordered in the same order as they declaration.
iv. Scope of methods should limit access as much as possible.
v. Other methods should be ordered based on access modifiers, followed by workflow order.

Notes

Table of Contents

General Information

User Guide

Developer Guide

Clone this wiki locally