Przed Tobą krótki materiał opisujący szczegółowo komentarze występujące w języku Kotlin 🔔! Opowiemy sobie czym jest komentarz, jakie występują rodzaje komentarzy, a także kiedy i czy w ogóle warto je stosować! Wszystkich zainteresowanych zapraszam do zapoznania się z materiałem 😄!
WYJAŚNIAM DO CZEGO SŁUŻĄ KOMENTARZE W JĘZYKU KOTLIN!
Dla osób, które stykają się po raz pierwszy z tym pojęciem, przygotowałem wyjaśnienie czym jest komentarz w ogólnie przyjętym programowaniu (nie tylko w Kotlinie) 👍. Także jeżeli nie rozumiesz samego hasła, wystarczy że zerkniesz niżej na tłumaczenie 😊!
Czym jest komentarz w programowaniu?
W programowaniu, komentarz jest oznaczeniem w kodzie tekstu, który ma nie być uwzględniany przez kompilator lub interpreter (w zależności od tego, czy język jest kompilowany, czy skryptowy) 💡. Zazwyczaj stosuje się go w celu pozostawienia opisu słownego co robi dana instrukcja, blok instrukcji czy dowolny inny fragment kodu. Każda treść objęta komentarzem, nie będzie przetwarzana przez kompilator czy interpreter, zatem może odbiegać od składni i być dowolnego kształtu 🙂.
Częstą praktyką jest również zostawianie treści w postaci opisującej jedno z zadań do wykonania na później, znane pod hasłem "TODO" ℹ️.
Teraz przyjrzyjmy się rodzajom komentarzy jakie znajdziesz w języku Kotlin 🔍!
Jakie występują rodzaje komentarzy w języku Kotlin?
W Kotlinie znajdziesz 2 rodzaje komentarzy, które różnią się między sobą zarówno oznaczeniem w kodzie, jak i zastosowaniem. Są to 👇:
- komentarz liniowy (obejmuje tylko jeden wiersz kodu),
- komentarz blokowy (obejmuje wiele wierszy kodu).
Dowiedzmy się więcej na ich temat!
Czym jest komentarz liniowy w języku Kotlin?
Komentarz liniowy to taki rodzaj komentarza, który dotyczy tylko jednego wiersza. Umieszczając dwa ukośniki obok siebie bez spacji 👇:
// To jest komentarz liniowy.możemy zaraz po nich pisać dowolną treść, nawet odbiegającą od zasad składni Kotlina i nic złego się nie stanie 😄.
 |
Komentarz liniowy w języku Kotlin pozwala na wykluczenie jednego wiersza kodu z analizowania jego treści przez kompilator, dzięki czemu możemy do niego wstawić dowolne hasła wykraczające poza zasady składni!
W sytuacji, gdy zajdzie potrzeba utworzenia całego bloku, który ma nie być brany pod uwagę przez kompilator, należy skorzystać z komentarza blokowego!
Czym jest komentarz blokowy w języku Kotlin?
Komentarz blokowy jest drugim rodzajem komentarza polegającym na utworzeniu całego bloku kodu, wewnątrz którego możemy pisać treść w dowolnej formie. Komentarz blokowy tworzy się inaczej niż liniowy, ponieważ wymaga umieszczenia dwóch różnych symboli oznaczających początek i koniec tego bloku 🔥.
Symbolem rozpoczynającym komentarz blokowy w Kotlinie, jest kombinacja znaków w postaci ukośnika i asterysku (nazywany "gwiazdką") 👇:
/*Zaraz po nim, określamy ile wierszy kodu chcemy mieć przeznaczonych dla naszych komentarzy, a potem wstawiamy drugi symbol będący odwrotnym do pierwszego, czyli najpierw asterysk, potem ukośnik 👇:
*/To oznacza zakończenie komentarza blokowego. Tak wygląda prosty przykład ukazujący komentarz blokowy w całości 👇:
/*
To
jest
komentarz
blokowy.
*/Warto wiedzieć, że w tym języku możemy tworzyć zagnieżdżenia, czyli umieszczać jeden blok w drugim! Na przykład 👇:
/*
To
jest
/*
To
jest
komentarz
blokowy.
*/
komentarz
blokowy.
*/Kompilator nie będzie miał nic przeciwko temu, aczkolwiek wiedz, że nie każdy język programowania zezwoli Ci na taki zapis 💥. Wtedy pozostanie Ci tylko utworzyć drugi taki blok "na zewnątrz" 👇:
/*
To
jest
pierwszy
komentarz
blokowy.
*/
/*
To
jest
drugi
komentarz
blokowy.
*/Natomiast w Kotlinie i jeden, i drugi zapis, będzie poprawny ✔️.
 |
Komentarz blokowy w języku Kotlin jest przeznaczony do tworzenia bloków do pisania dowolnych treści, które nie będą uwzględniane przez interpreter!
To już wszystko co należało o tym napisać. Na sam koniec ostatnie zagadnienie czy warto korzystać z komentarzy w kodzie ❗!
Czy warto stosować komentarze w języku Kotlin?
To pytanie po części wkracza w gusta programisty, bo jeden może lubić umieszczać komentarze, a drugi niespecjalnie 😅. Jeżeli jednak popatrzymy na to wyłącznie od strony przydatności, to dla mnie najlepszą odpowiedzią jest: "stosować je najmniej razy, ile się da".
Komentarze nie wpływają na działanie programu, mają charakter jedynie informacyjny ℹ️. Natomiast dużo lepiej nauczyć się pisać kod w taki sposób, aby on sam wyjaśniał klarownie do czego służy, bez sięgania po język abstrakcyjny 👍. Wymaga to sporych umiejętności, natomiast da się tak pisać kod (jest to jak najbardziej możliwe) 💖.
Jest to jeszcze istotniejszy argument z tego względu, iż istnieje ryzyko, że gdy wrócimy do danego kodu z komentarzem i wprowadzimy zmiany, to możemy zapomnieć o zaktualizowaniu samego komentarza. Wtedy pojawia się dezinformacja, która może nas zatrzymać na krótszy lub dłuższy czas, a to nigdy nie jest fajne w zawodzie programisty 😐. Kod źródłowy zawsze trzeba zmodyfikować. Komentarz jest już tylko opcjonalny.
Oczywiście najlepiej jak sam(a) zdecydujesz czy będziesz chciał(a) zostawiać komentarze w kodzie i jeżeli tak, to nie ma w tym niczego złego 😁. Tylko po prostu pamiętaj później, aby po każdej modyfikacji kodu nie zapomnieć też o samym komentarzu 🫵!
To tyle w temacie! Mam nadzieję, że wyniesiesz z tego materiału coś pożytecznego dla siebie i będziesz w stanie określić czy będziesz miał(a) ochotę korzystać z komentarzy w przyszłości, wraz z nabywaniem wiedzy 😉!