Code Style

We are using the Google Java code style.

Code style is enforced by Checkstyle. If you notice any missing rules, either add them or contact kubik369.

You can check the codestyle on your local machine by downloading Checkstyle into the root of the project and executing this command:

java -jar checkstyle-7.6-all.jar -c checkstyle.xml src/main/java

Javadoc

For shorter descriptions without @params use single line javadocs as such:

/** Retrieves the X-coordinate of the vertex */
public double getX() {
  return this.x;
}

For multiline docs, do not use the first line starting with /**:

/**
 * Retrieves the X-coordinate of the vertex
 * @return X-coordinate of the vertex
 */
public double getX() {
  return this.x;
}