Jak komentować w Javie?

Polecenia są bardzo ważne w programowaniu komputerowym. Są to proste wyjaśnienia kodu źródłowego, które sprawiają, że kod źródłowy jest bardziej zrozumiały dla ludzi. Nie są one jednak uwzględniane przez kompilatora ani tłumacza.

Znaczenie komentarzy

Jak omówiono powyżej, komentarze są konieczne, ponieważ sprawiają, że program komputerowy jest bardziej zrozumiały. Plusy komentarzy są wymienione poniżej.

• Sprawia, że ​​kod jest łatwy do odczytania.
• Bez wysiłku konserwacja kodu i wykrywanie błędów.
• Podaj szczegóły dotyczące określonej metody, klasy, zmiennej lub instrukcji.
• Funkcje napisane przez innych stają się łatwiejsze do zrozumienia.

Podobnie jak w innych językach programowania, możesz również pisać komentarze w Javie. Ten zapis bada różne rodzaje komentarzy Java i sposób ich używania wraz z ich przykładami.

Rodzaje komentarzy Java

W Javie istnieją trzy podejścia do komentarza, jak pokazano poniżej.

Komentarz z pojedynczą linią

Aby skomentować jedno wierszowe komentarze z pojedynczym wierszem, które zaczynają się od dwóch cięć do przodu. Tekst napisany po tym, jak te cięcia są ignorowane przez kompilator Java.

Oto składnia komentarza Java jednoliniowego:

// To jest komentarz jednoliniowy

Przykład

Komentarz wieloliniowy

Kiedy chcesz skomentować wiele wierszy w swoim kodzie źródłowym Java, użyj komentarza wieloletniego. Zaczyna się od / * i kończy się * /. Tekst napisany pomiędzy nimi nie zostanie wykonywany przez kompilator Java.

Składnia

/ * To jest komentarz wieloletnie */

Przykład

Komentarz dokumentacji

Komentarze dokumentacyjne są zwykle używane do tworzenia interfejsu API dokumentacji dla większych programów Java. Te interfejsy API dokumentacji są używane do referencji klas, metod i argumentów używanych w kodzie źródłowym. Zaczyna się od /** i kończy się* /.

Oto składnia komentarza typu dokumentacji w Javie.

/**
*
*Aby przedstawić parametry, używamy różnych tagów
*lub metoda lub nagłówek
*Lub możemy użyć tagów HTML
*
*/

Przykład

Tabela podana poniżej obejmuje wiele rodzajów tagów Javadoc.

Nazwa znacznika	Składnia	Opis
@autor	@Author Name-Text	Służy do napisania nazwy autora konkretnej klasy.
@wersja	@Version Version-Text	Służy do wspomnienia tekstu wersji.
@param	@Parameter Opis nazwy	Służy do dodawania nazwy parametrów i opisu.
@powrót	@return Opis	Służy do łatwego znalezienia wartości powrotnych, tworząc sekcję „zwrotu”.
@deprecated	@Depreced Tekst	Służy do wskazania przestarzałej klasy lub metody lub złożony i tworzy ostrzeżenie za każdym razem, gdy jest używany przez kogoś.
@od	@Since wydanie	Służy do określenia wersji metody lub klasy itp.
@throws	@throws Opis nazwy klas	Służy do rzucenia wyjątku.
@wyjątek	@Exception Opis nazwy klasy	Ma podobne zastosowanie jak znacznik @throw.
@Widzieć	@See Reference	Służy do dodania odniesienia do metody lub klasy poprzez generowanie linku w sekcji „patrz także”.
@seryjny	@Serial Description | Uwzględnij | wykluczać	Służy do dodawania odpowiednich informacji o serializowanych polach.
@Serialfield	@Serial Field-Field-Field Field Description	Służy do dokumentowania komponentu ObjectStreamfield.
@Serialdata	@SerialData Description	Służy do dokumentowania danych zapisanych metodami takimi jak ParterObject () lub Writexternal ().
@docroot	@docroot	Służy do pokazywania ścieżki katalogu głównego.
@kod	@Code Text	Służy do wyświetlania tekstu w czcionkach kodu.
@wartość	@Value Pakiet.Class#Field	Służy do wyświetlania wartości stałej, gdy komentarz do dokumentu jest zapisywany w polu statycznym.
@inheritdoc	-	Służy do odziedziczenia komentarza od odziedziczonej klasy.
@połączyć	Pakiet @Link.Etykieta członkowska klasy#	Zawiera link, który koncentruje dokumentację dla konkretnego pakietu, klasy lub nazwy członka klasy, która jest odwołana.
@Linkplain	@Linkplain pakiet.Etykieta członkowska klasy#	Podobne do linku z jedyną różnicą, że etykieta łącza jest wyświetlana w prostym tekście, a nie tekstu kodu.

Wniosek

Istnieją trzy rodzaje komentarzy w Javie. Pierwszy to komentarz jednokierunkowy, który zaczyna się od dwóch cięć do przodu „//”, drugi to wieloletni komentarz, który zaczyna się od/ *, a kończy */, podczas gdy ostatni to dokumentacja, który służy do tworzenia do tworzenia API dokumentacji dla dużych programów i aplikacji Java. Wszystkie te rodzaje komentarzy zostały wyjaśnione w tym samouczku wraz z tagami Javadoc, które są używane w komentarzach do dokumentacji.