Pisząc kod dokonujemy decyzji, jakie wybrać nazewnicto, jaki sposób rozwiązania problemy. Skopiowanie i użycie gotowego rozwiązania też jest podjęciem decyzji. Zauważenie i zignorowanie błędu też jest decyzją. Każda decyzja powinna zostać świadomie podjęta. Powinniśmy mieć świadomość zalet i wad naszych decyzji. Nie pozwalajmy aby to przypadek decydował o jakości naszego kodu.
Poniżej przedstawiam dobre praktyki.
Ogólne:
- Kod piszemy w języku angielskim.
- Wybieramy proste i czytelne nazwy.
- Stosujmy tę samą konwencję w całym projekcie (prefiksy i postfiksy w nazwach).
- Należy unikać powtórzeń takich samych linii w kodzie i takich samych bloków.
- Klasa powinna mieć maksymalnie 200 linii, metoda 30 linii, a linia 100 znaków. Ilość linii jest umowna, a odpowiada to potrzebie aby klasa była na tyle krótka aby w całości była zrozumiała, a metoda w całości widoczna na ekranie.
Baza danych:
- Pobieramy z bazy danych tylko tyle danych ile potrzebujemy. Sortowanie, filtrowanie, grupowanie powinny się odbywać po stronie bazy danych.
Testy jednostkowe:
- Test jednostkowy powinien testować jedną klasę, powinien mieć nazwę taką jak testowana klasa z postfiksem Test, powinien się znajdować w tym samym pakiecie co testowana klasa.
Nazewnictwo Java
- nazwa pakietu – com.lowercase
- nazwa klasy/interfejsu/enuma – CapitalizedCamelCase
- nazwa pola klasy – camelCase
- nazwa metody – camelCase
- wartość enuma – UNDERSCORE_UPPER_CASE
- url – lower-hyphen