Kurs Java #3 Komentarze i samo dokumentujący się kod. Jest to podstawa dla osób piszących aplikacje w języku java czy testerów automatyzujących. To bardzo krótka lekcja w której poznasz w praktyce jak dodawać komentarze i jak wyglądają dobre praktyki. Komentarze to swego rodzaju notatki czy zapiski programisty w kodzie aplikacji. Ich celem jest przekazanie informacji dla siebie samego lub innego dewelopera czy testera.
Rodzaje komentarzy w Javie.
Podstawową kwestią jest to, że komentarze są widoczne jedynie dla nas. Przy kompilacji są one pomijane i nie mają żadnego wpływu na działanie programu.
W języku Javie istnieją trzy rodzaje komentarzy:
- // text – tekst umieszczony jest za podwojonym znaku slasha jest uznawany za komentarz aż do końca danej linii;
- /* text */ – tekst jest umieszczony w takich znacznikach. Jest on traktowany jako komentarz przez wiele linii kodu;
- /** text */ – to również komentarz kilku linijkowy, ale dodatkowo wykorzystywany jest do tworzenia dokumentacji.
Pseudokod.
public class Komentarze{
//To jest nasz pierwszy komentarz
public static void main(String[] args){
/*Ten komentarz
ktory jest wpisany
przez wiele linii kodu */
System.out.print("Czesc testerzy");
}
}Ważne jest by nie za komentować części kodu, bo nie będzie on widoczny dla kompilatora.
Dobre praktyki
Komentarze służą by poprawić czytelności kodu. Z tego względu nie powinno się dodawać ich na siłę do każdego fragmentu kodu. Dodawaj komentarze jedynie w miejscach, gdzie czujesz że przydałoby się jakieś wyjaśnienie dla innych osób, czy też dla Ciebie gdy wrócisz do kodu po dłuższym czasie. Proszę pamiętaj by komentarze powinny być zastępowane czytelnym kodem, który nie wymaga dodatkowych uwag. W związku z takim pisaniem kodu powstaje tak zwany samodokumentujący się kod. Doskonałym przykładem jest to, że lepiej jest nadać metodzie opisową nazwę niż wyjaśniać w komentarzu, co piszący kod miał na myśli.
Do czego używa komentarzy tester.
Tester podobnie jak programista używa komentarzy do opisania ważnych miejsc w kodzie. Dodatkowo tester może często stosować komentarze przy pisaniu testów Selenium. Wykonując jakieś ważne kroki w sporządzaniu testów, możemy przekazywać informację by wytłumaczyć innej osobie, co chcieliśmy wykonać. Oczywiście dla osób początkujących brzmi to abstrakcyjnie, zostanie to wyjaśnione później, oraz w ramach lekcji z Selenium.
Podsumowanie
Lekcja – Kurs Java #3 Komentarze, została ukończona. Potrafisz już dodawać komentarze. Więcej artykułów o Javie będzie w sekcji kursu Javy. W ramach nauki korzystamy z InteliJ Idea.
