Dowiedzmy się, czym są komentarze i dlaczego są ważne w programowaniu.
Omówimy również dwa popularne typy komentarzy i sposoby ich pisania w 15 różnych językach programowania.
Spis treści:
Czym są komentarze w programowaniu?
Komentarze w kategoriach laika to fragmenty tekstu, które nie będą widoczne dla użytkowników końcowych i służą jako odniesienie dla osób piszących kod.
Nieco bardziej formalnie, komentarz to opis programu o tym, jak on działa w prostym, czytelnym formacie. Są one zwykle używane w miejscach, w których programistom czytającym kod należy zapewnić dodatkową przejrzystość. Tym samym pomaga to w poprawie czytelności kodu oraz skraca czas i komunikację, które byłyby wymagane do przekazywania wiedzy.
Kompilator/Interpreter po prostu ignoruje komentarze w twoim kodzie, nie wpływając w ten sposób na końcowe wyjście twojego programu. Krótko mówiąc, komentarze są jak proste, czytelne wyjaśnienie niektórych fragmentów kodu.
Typowe typy komentarzy
Większość języków programowania obsługuje 2 rodzaje komentarzy.
- Komentarz jednowierszowy
- Komentarz wielowierszowy / komentarze blokowe
Jak sama nazwa wskazuje, komentarze jednowierszowe są przydatne, gdy trzeba dodać mały tekst jednowierszowy, np. określony warunek, stała wartość, która wymaga krótkiego opisu. Natomiast wielolinijkowe działają lepiej, gdy mamy do dodania większą ilość informacji, takich jak opis funkcji i sposobu jej użycia itp.
Istnieją inne typy komentarzy, takie jak komentarze do dokumentów, ale wykraczają one poza zakres tego artykułu.
Dlaczego warto dodawać komentarze?
„Każdy głupiec może napisać kod zrozumiały dla komputera. Dobrzy programiści piszą kod zrozumiały dla ludzi”. — Marcin Fowler
Główną zaletą dodawania komentarzy jest zwiększona czytelność i lepsze zrozumienie programu. Oprócz tego, niektóre inne zalety obejmują –
- Komentarze bardzo ułatwiają Twoim współpracownikom, a nawet innym programistom zrozumienie logiki bez czytania długiej dokumentacji.
- Ograniczona komunikacja między programistami w przypadku drobnych wątpliwości
- Komentarze są ignorowane przez kompilator/interpretatory.
- W przypadku oprogramowania open source są one koniecznością, ponieważ nie będziesz tam, aby wyjaśnić każdą funkcję milionom programistów, którzy chcą korzystać z tego konkretnego programu.
Komentarze w wielu językach
Wspaniale, teraz, gdy dowiedzieliśmy się o komentarzach i dlaczego są przydatne. Przyjrzyjmy się, jak możemy dodawać komentarze w różnych językach programowania.
Komentarz jednowierszowy
// This is a single line comment in C/C++
Komentarz wielowierszowy
/* This is slightly long multi line comment in C/C++ */
Komentarz jednowierszowy
# This is a single line comment in Python
Komentarz wielowierszowy
# This is slightly long # multi line comment in Python
Komentarz jednowierszowy
// This is a single line comment in Java
Komentarz wielowierszowy
/* This is slightly long multi line comment in Java */
Komentarz jednowierszowy
# This is a single line comment in Ruby
Komentarz wielowierszowy
=begin This is slightly long multi line comment in Ruby =end
Komentarz jednowierszowy
// This is a single line comment in Golang
Komentarz wielowierszowy
/* This is slightly long multi line comment in Golang */
Komentarz jednowierszowy
– – This is a single line comment in Haskell
Komentarz wielowierszowy
{- This is slightly long
multi line comment in Haskell -}
Komentarz jednowierszowy
// This is a single line comment in Rust
Komentarz wielowierszowy
/* This is slightly long multi line comment in Rust */
Komentarz jednowierszowy
<!-- This is a single line comment in HTML -->
Komentarz wielowierszowy
<!-- This is slightly long multi line comment in HTML -->
Komentarz jednowierszowy
/* This is a single line comment in CSS */
Komentarz wielowierszowy
/* This is slightly long multi line comment in CSS */
Komentarz jednowierszowy
// This is a single line comment in Javascript
Komentarz wielowierszowy
/* This is slightly long multi line comment in Javascript */
Komentarz jednowierszowy
# This is a single line comment in R programming language
Komentarz wielowierszowy
R nie obsługuje komentarzy wielowierszowych.
Komentarz jednowierszowy
% This is a single line comment in Erlang
Komentarz wielowierszowy
R nie obsługuje komentarzy wielowierszowych.
Komentarz jednowierszowy
// This is a single line comment in PHP
Komentarz wielowierszowy
/* This is slightly long multi line comment in PHP */
Komentarz jednowierszowy
# This is a single line comment in Perl
Komentarz wielowierszowy
=begin This is slightly long multi line comment in Perl =end
Komentarz jednowierszowy
// This is a single line comment in Kotlin
Komentarz wielowierszowy
/* This is slightly long multi line comment in Kotlin */
Wniosek
W samouczku omówiono podstawy dotyczące komentarzy i 2 popularne typy — jednowierszowy i wielowierszowy. Starałem się również wyjaśnić, dlaczego komentarze są przydatne i należy je pisać w razie potrzeby. Mam nadzieję, że nauczyłeś się czegoś nowego!
Eksploruj dalej. Ucz się! 👨💻