Skip to content

Commit

Permalink
added clean code
Browse files Browse the repository at this point in the history
  • Loading branch information
hohwille authored May 28, 2024
1 parent 998ef92 commit 54b5ba2
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions documentation/coding-conventions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,14 @@ As a general goal, the code should be easy to read and understand. Besides, clea
* To document implementation details, we use code comments (e.g. `// we have to flush explicitly to ensure version is up-to-date`). This is only needed for complex logic.
* Avoid the pointless `{@inheritDoc}` as since Java 1.5 there is the `@Override` annotation for overridden methods and your JavaDoc is inherited automatically even without any JavaDoc comment at all.

== Clean Code
The book https://www.pearson.de/clean-code-a-handbook-of-agile-software-craftsmanship-9780132350884[Clean Code] gives a collection of helpful rules and guidelines for coding.
A https://gist.github.com/wojteklu/73c6914cc446146b8b533c0988cf8d29[summary] can be found here.

Most important explicit aspects are:

* Do not push out-commented code (see also https://rules.sonarsource.com/java/RSPEC-125/[RSPEC-125] rule from SonarQube)

== Catching and handling Exceptions
When catching exceptions always ensure the following:

Expand Down

0 comments on commit 54b5ba2

Please sign in to comment.