Basic_coding_conventions_we_use - Simplix-Softworks/SimplixCore GitHub Wiki
Basic coding conventions we use
SOLID principles
Using solid principles is quite important to us. A brilliant guide to them can be found here.
Effective Java
We generally emphasize the principles shown in the book Effective Java
Null handling
"Null sucks." -Doug Lea
"I call it my billion-dollar mistake." - Sir C. A. R. Hoare, on his invention of the null reference
-
@NonNull
All parameters of public methods that may not take in a null value must be annotated with lombok's @NonNull.
-
Optional
All public methods that can return a nullable value must return an optional instead. A reference to the java.lang.Optional can be found here
-
@Nullable
All parameters that might take in a null value must be annotated with JetBrains @Nullable annotation.