Skip to content

Latest commit

 

History

History
66 lines (33 loc) · 1.13 KB

File metadata and controls

66 lines (33 loc) · 1.13 KB

StyleGuide

The "Vishal" style of code.


Rules

Whitespace

Adopted directly from Google's Java Style Guide:

https://google.github.io/styleguide/javaguide.html#s2.3.1-whitespace-characters

Indentation

Indentation Style

https://en.wikipedia.org/wiki/Indent_style#Allman_style

Indentation Size

4 Spaces

Indentation Composition

No Tabs..only spaces.

It is recommended that you configure your editor/IDE to soft-tab your tab character into 4 spaces. You can verify this is working when you tab and then left-arrow. If you configured this correctly, you should need to left-arrow 4 times until you've reached the starting position of the tab.

Spacing

Space between all tokens except for sides of parentheses.

Imports

No wildcard imports are permitted.

Javadoc

Adopted directly from Google's Java Style Guide:

https://google.github.io/styleguide/javaguide.html#s7-javadoc

with the additional proviso of using

/**
 * {@inheritDoc}
 */

when this is more appropriate than not having any Javadoc on inherited members.


Recommendations

Effective Java