Create Code Styling authored by Brennan Mulligan's avatar Brennan Mulligan
# CheckStyle
Whenever you believe you have completed a task, make sure to run CheckStyle in the configurations. The code will fail when running in the pipeline if it does not follow the correct styling.
Curly Brackets **{** should be on the next line, not the same line.
For example,
```java
public boolean pleaseDoThis()
{
return true;
}
```
***NOT***
```java
public boolean dontDoThis() {
return false;
}
```
Also, you want to make sure you add one more line of white space at the end of your classes.
# Whitespace
```
Do not leave
large amounts
of unnecessary
whitespace.
```
# Comments
Keep it **brief** and **easy to understand**. Only add comments if the variable and method names do not clearly explain what is happening or for complex segments. Too many comments ***hinders*** readability.
Make sure to remove all **unnecessary comments**. This includes code that you had commented out for later, TODOs, and other miscellaneous notes that do not help others understand the code. It is fine to use them as part of the process, but try to avoid having them reach main or carry into the next iteration.
\ No newline at end of file