W tym artykule dowiesz się o komentarzach Kotlin oraz dlaczego i jak ich używać.
W programowaniu komentarze są częścią programu przeznaczoną dla Ciebie i innych programistów do zrozumienia kodu. Są one całkowicie ignorowane przez kompilator Kotlin (Kompiler).
Podobnie jak w Javie, w Kotlinie są dwa typy komentarzy
/*… *///… .
Tradycyjny komentarz / *… * /
To jest komentarz wielowierszowy, który może obejmować wiele linii. Kompilator Kotlin ignoruje wszystko od /*do */. Na przykład,
/* This is a multi-line comment. * The problem prints "Hello, World!" to the standard output. */ fun main(args: Array) ( println("Hello, World!") )
Komentarz do tradycji jest również używany do dokumentowania kodu Kotlin (KDoc) z niewielkimi zmianami. Komentarze KDoc zaczynają się /**i kończą na */.
Komentarz końca linii //
Kompilator ignoruje wszystko, od //do końca wiersza. Na przykład,
// Kotlin Hello World Program fun main (args: Array) (println ("Hello, World!") // wyświetla na ekranie Hello, World!)
Powyższy program zawiera dwa komentarze końca linii:
// Program Kotlin Hello World
i
// wyświetla Hello, World! na ekranie
Używaj komentarzy we właściwy sposób
Komentarze nie powinny zastępować sposobu na wyjaśnienie źle napisanego kodu w języku angielskim. Napisz dobrze skonstruowany i czytelny kod, a następnie użyj komentarzy.
Niektórzy uważają, że kod powinien samodokumentować się, a komentarzy powinno być niewiele. Jednak całkowicie się z tym nie zgadzam (to moja osobista opinia). Nie ma nic złego w używaniu komentarzy do wyjaśniania złożonych algorytmów, wyrażeń regularnych lub scenariuszy, w których do rozwiązania problemu wybrano jedną technikę zamiast drugiej (do wykorzystania w przyszłości).
W większości przypadków użyj komentarzy, aby wyjaśnić „dlaczego” zamiast „jak” i gotowe.
