Code Style for ERP project - Pyxsys/SOEN390_19 GitHub Wiki

Naming Conventions

Variables (snake_case)

Variables should have general names that allude to their purpose. Final variables must be in uppercase.

output-item = new Item();
foo(String input_string);
public static final int MAX_CAPACITY = 5;

Functions (camelCase)

Method names must be concise and describe their function or utility.

foo();
fooBar();
renameUnamedFile(File input_file);

Classes (PascalCase)

Class names should be concise and allude to the responsibility/purpose of that class.

BikeManufacturer{...}
AbstractContact{...}
Bike{...}
BusinessTransaction{...}

Files (PascalCase)

Files should follow similar protocols to classes, outlining their responsibility/purpose. Dashes may be used to separate pertinent attribute info.

ConsoleLog.log
SaleReceipt321-Company123.pdf
Invoice-2394823134123.pdf
DatabaseSnapshot-1stJan2021-2021-01-27-1548

Packages (PascalCase)

Package names must be general enough to evoke the idea of the responsibilities/functions of its contents.

Files
TransportManufacturing
ProductModels
Employees