W tym samouczku dowiesz się o komentarzach Java, dlaczego ich używamy i jak używać komentarzy we właściwy sposób.
W programowaniu komputerowym komentarze są częścią programu, która jest całkowicie ignorowana przez kompilatory języka Java. Służą głównie do pomocy programistom w zrozumieniu kodu. Na przykład,
// declare and initialize two variables int a =1; int b = 3; // print the output System.out.println("This is output");
Tutaj użyliśmy następujących komentarzy,
- zadeklaruj i zainicjalizuj dwie zmienne
- wydrukować wynik
Rodzaje komentarzy w Javie
W Javie istnieją dwa typy komentarzy:
- komentarz jednowierszowy
- komentarz wielowierszowy
Komentarz jednowierszowy
Komentarz jednowierszowy zaczyna się i kończy w tym samym wierszu. Aby napisać komentarz jednowierszowy, możemy użyć //symbolu. Na przykład,
// "Hello, World!" program example class Main ( public static void main(String() args) ( ( // prints "Hello, World!" System.out.println("Hello, World!"); ) )
Wyjście :
Witaj świecie!
Tutaj użyliśmy dwóch jednowierszowych komentarzy:
- "Witaj świecie!" przykład programu
- wyświetla "Hello World!"
Kompilator Java ignoruje wszystko od //końca wiersza. Dlatego jest również znany jako komentarz końca wiersza .
Komentarz wielowierszowy
Kiedy chcemy pisać komentarze w wielu wierszach, możemy użyć komentarza wieloliniowego. Aby pisać komentarze wielowierszowe, możemy użyć symbolu / *…. * /. Na przykład,
/* This is an example of multi-line comment. * The program prints "Hello, World!" to the standard output. */ class HelloWorld ( public static void main(String() args) ( ( System.out.println("Hello, World!"); ) )
Wyjście :
Witaj świecie!
Tutaj użyliśmy komentarza wielowierszowego:
/* This is an example of multi-line comment. * The program prints "Hello, World!" to the standard output. */
Ten typ komentarza jest również nazywany komentarzem tradycyjnym . W tego typu komentarzach kompilator Java ignoruje wszystko od /*do */.
Używaj komentarzy we właściwy sposób
Należy zawsze wziąć pod uwagę, że komentarze nie powinny zastępować sposobu na wyjaśnienie źle napisanego kodu w języku angielskim. Zawsze powinieneś pisać dobrze zorganizowany i zrozumiały kod. A następnie użyj komentarzy.
Niektórzy uważają, że kod powinien być samoopisujący, a komentarze powinny być rzadko używane. Jednak moim zdaniem nie ma nic złego w używaniu komentarzy. Możemy użyć komentarzy, aby wyjaśnić złożone algorytmy, wyrażenia regularne lub scenariusze, w których musimy wybrać jedną technikę spośród różnych technik rozwiązywania problemów.
Uwaga : w większości przypadków zawsze używaj komentarzy, aby wyjaśnić „ dlaczego ”, a nie „ jak ”, i dobrze jest zacząć.
