-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
32 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# Guide to effective java programming | ||
|
||
## Always use java packages | ||
Your project should have proper [java package](https://en.wikipedia.org/wiki/Java_package) structure from day 1. | ||
A Java package organizes Java classes into namespaces providing a unique namespace for each type it contains. | ||
|
||
## Always use logger | ||
Always use [logger](https://www.vogella.com/tutorials/Logging/article.html). | ||
Don't use ``System.out.println("my log statement")`` for logging in yor code ! | ||
|
||
## Create JUnit tests | ||
From day 1, test your code ! Write code to be testable automatically ! | ||
Use [JUnit](https://junit.org/junit5/docs/current/user-guide/) to create automated tests. | ||
|
||
## Use Static Code analyzer | ||
Many IDEs have possibility ro use static code analysis to prevent bugs. | ||
[Sonar Lint](https://www.sonarlint.org/) recommended. It is available as plugin for Intellij IDEA and Eclipse. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters