SE2811
Coding Standard
Please see the style guide on Dr. Hasker's page.
There are two exceptions from Dr. Hasker's style guide:
This requirement is removed:
adding spaces around operators such as *, +, <, ==, &&: x * y < a, not x*y<a
And these requirements are added:
- Do not screenshot EA. If you instead print to PDF or copy-paste the elements natively from EA to any other program (Paint, Word, ...), it will remove the gradient background (which is distracting to me) and more importantly reduce the risk of showing a class selected (which looks tacky to me). (Added 28 Dec 2018)
- Document each class with a Javadoc comment that briefly describes the responsibilities of the class unless otherwise specified (Updated 28 Dec 2018)