- Java 8 only. For the time being, there are no other JVM languages (the next consideration is Kotlin).
- Java 9 is not supported, unfortunately.
- Use
private static final Logger LOGGERinstances where logging is necessary. See SemiRobot.java for an example. - Null is bad.
Avoid nulls wherever possible.
State all accepted inputs as nullable or non-null. The last thing that should
happen is that the robot locks up and crashes with a NullPointerException
due to poor practices.
- If nulls are used in non-closed scope situations, you will have to justify its use. You will most likely be asked to rewrite it without null.
- Four spaces ONLY
- Correct indentations for all code
- Keep it neat, please. This won't be nitpicked to a T, but it shouldn't look like a bomb went off.
- EVERY Javadoc-able thing needs Javadoc documentation, unless it is:
- A
private static final Logger LOGGERinstance in a class - An obvious getter/setter
- Note that normal code should only be commented with normal comments
- A
- All documentation must be grammatically correct English with no spelling errors
- Note: text for
@tagslike@paramor@returnsdo not need a full stop
- Note: text for
- See PlateAssignment.java for a thorough example.