Komentarze w Javie

Komentarze w Javie , podobnie jak w większości innych języków programowania, to znaki ignorowane podczas wykonywania programu. Dzięki temu możesz dodawać do programu dowolną liczbę komentarzy, bez obawy o zwiększenie jego rozmiaru. Komentarze służą do opisu zawiłości konkretnego bloku kodu, metody lub klasy. Możesz ich także użyć, jeśli chcesz zostawić wiadomości programistom, którzy będą pracować z tym kodem w przyszłości. Lub do własnych notatek.

Sposoby wyróżniania komentarzy

Java udostępnia dwa sposoby wyróżniania komentarzy w tekście.

Komentarz do implementacji (komentarz do kodu)

1. Komentowanie wiersza

   Jest to najczęściej używany typ komentarza. Aby napisać taki komentarz, musisz użyć dwóch ukośników //. W takim przypadku komentarz rozpoczyna się bezpośrednio po znakach //i trwa do końca wiersza.

   System.out.println("Hello, Java world!");
   // наш комментарий

2. Komentowanie bloku tekstu

   Jeśli potrzebujesz dłuższych komentarzy, możesz rozpocząć każdą linię symbolami. Chociaż wygodniej jest ograniczyć bloki komentarzy do ograniczników /*i */.

   /*
    Пример простой программы на Java
   */
   
   public class SampleProgram
   {
    public static void main (String [] args)
    {
    System.out.println("Hello, Java world!");
    }
   }

   Nie powinniśmy zapominać, że komentarzy oddzielonych symbolami /*nie można */zagnieżdżać w języku Java. Oznacza to, że fragmentu kodu nie można wyłączyć po prostu otaczając go znakami /*i , ponieważ wyłączany kod może sam zawierać */ograniczniki /*i */.

Dokumentujący komentarz

Do dokumentowania metod, zmiennych czy klas stosowana jest specjalna metoda podświetlania tekstu. Odbywa się to za pomocą /**i */. W tym przypadku każda linia komentowanego tekstu zaczyna się od *.Jeśli metoda jest udokumentowana, zwyczajowo opisuje się jej argumenty i zwracaną wartość.

/**
* Метод возвращает максимальное oznaczający
* из трех переданных аргументов
* @param a - первый параметр
* @param b - второй параметр
* @param c - третий параметр
* @return - максимальный из параметров
*/
public int max(int a, int b, int c) {
   return Math.max(Math.max(a, b), c);
}

Co jeszcze przeczytać? Na przykład ten materiał: Komentarze w Javie: nie wszystko jest takie proste . Lub wykład z zadania Java Syntax Pro na temat komentarzy.