Code formatting is important.
Each blank line is a visual cue that identifies a new and separate concept.
There are blank lines that separate the package declaration, the import(s), and each of the functions.
Lines of code that are tightly related should appear vertically dense.
The useless comments break the close association of the two instance variables.
If one function calls another, they should be vertically close, and the caller should be above the callee.
We use horizontal white space to associate things that are strongly related and disassociate things that are more weakly related.
- (1) I didn’t put spaces between the function names and the opening parenthesis. This is because the function and its arguments are closely related. Separating them makes them appear disjoined instead of conjoined.
- (2) I surrounded the assignment operators with white space to accentuate them. Assignment statements have two distinct and major elements: the left side and the right side
- (3) I separate arguments within the function call parenthesis to accentuate the comma and show that the arguments are separate.
Every programmer has his/her own favorite formatting rules, but if he/she works in a team, then the team rules.
A team of developers should agree upon a single formatting style, and then every member of that team should use that style. We want the software to have a consistent style. We don’t want it to appear to have been written by a bunch of disagreeing individuals.
The rules we should follow are coding standards documents: