Co jsou komentáře v Javě a jak je vytvářet

V jazyce Java existují tři různé typy komentářů. Komentáře můžete použít ke strukturování a vysvětlení svého kódu. Jednořádkové komentáře slouží pro krátké poznámky, zatímco blokové komentáře jsou vhodné pro delší vysvětlení. Dokumentační komentáře jsou naopak rozsáhlé a nabízejí hodnotu nad rámec zdrojového kódu.

Co jsou komentáře v Javě?

Práce se zdrojovým kódem může někdy představovat problém i pro zkušené vývojáře. V závislosti na projektu a jeho rozsahu se situace může rychle stát nepředvídatelnou a kód může být matoucí. V takových případech možná nebudete chtít pracovat na kódu sami. Ale i když budete chtít, aby k vašemu kódu měli přístup i ostatní, nemusí být schopni jej intuitivně pochopit.

Aby se předešlo nedorozuměním a kód byl přehlednější, umožňuje Java uživatelům psát komentáře. Komentáře v tomto programovacím jazyce můžete použít k vysvětlení svého myšlenkového procesu, výpočtů, metod, tříd nebo struktur. Až se později vy nebo někdo jiný podíváte na kód, komentáře vám práci s ním usnadní.

Aby byly komentáře účinné, je důležité, aby byly co nejkratší. Zároveň by měly čtenářům poskytovat dostatek informací. Při řešení problémů jsou dobře formulované komentáře nezbytné.

Komentáře v jazyce Java jsou k dispozici ve třech různých verzích: jednořádkové komentáře, blokové komentáře (víceřádkové komentáře) a dokumentační komentáře. Všechny komentáře jsou označeny, takže se při kompilaci neberou v úvahu. V následujících částech vám ukážeme, jak vytvářet komentáře v jazyce Java a kdy který z nich použít.

Jaké typy komentářů existují v Javě?

V závislosti na druhu informací, které chcete zapsat, jsou v Javě k dispozici tři různé druhy komentářů. Jedná se o:

Jednořádkové komentáře

Toto je nejjednodušší možnost komentáře. Tento typ komentáře se vytváří pomocí dvou po sobě jdoucích lomítek (//) a nesmí být delší než jeden řádek. U jednořádkových komentářů není třeba označovat konec, protože ten je automaticky dosažen na konci řádku. Tento typ komentářů v jazyce Java je vhodný pro krátké komentáře, které vysvětlují funkci několika slovy.

Víceřádkové komentáře

Pokud vaše vysvětlení musí být trochu delší, můžete použít víceřádkové komentáře. Teoreticky mohou mít libovolnou délku. Jsou vhodné pro zahrnutí alternativních řádků kódu, které jsou vyloučeny z kompilace, nebo pro podrobná vysvětlení. Víceřádkové komentáře se uvádějí lomítkem a hvězdičkou (/*). Na konci komentáře stačí zadat hvězdičku následovanou lomítkem (*/). Text mezi úvodním lomítkem a závěrečným lomítkem je považován za komentář a při kompilaci kódu se nebere v úvahu.

Komentáře k dokumentaci

Zatímco jednořádkové a víceřádkové komentáře lze teoreticky vložit kamkoli do zdrojového kódu, dokumentační komentáře se vždy umisťují přímo před třídy nebo metody, které popisují. S pomocí nástrojů jsou tyto komentáře načteny a shrnuty v dokumentaci HTML. Používají se především k vytváření metadat pro autory a určité typy parametrů. Jsou označeny symbolem @. Dokumentační komentáře začínají lomítkem a dvěma hvězdičkami (/**) a končí hvězdičkou a lomítkem (*/).

Jednořádkové komentáře

Abychom pochopili, jak komentáře v Javě fungují v praxi, podíváme se na několik jednoduchých příkladů. Můžete si je sami vyzkoušet a otestovat výsledek. Jednořádkový komentář začíná dvěma lomítky a může být buď na samostatném řádku, nebo umístěn za sadou instrukcí. **. Takto vypadá komentář na samostatném řádku:

// Example of a single-line comment
class Main {
	public static void main(String[] args) {
	// Here is the comment
	System.out.println("This is the text that will be output at the end.");
	}
}

Pokud použijete příkaz Java System.out.println, zobrazí se pouze věta „Toto je text, který se zobrazí na konci“. Oba komentáře se zobrazí pouze ve zdrojovém kódu.

Alternativně můžete komentář umístit přímo za příkaz:

// Example of a single-line comment
class Main {
public static void main(String[] args) {
System.out.println("This is the text that is output at the end."); // This is the comment.
	}
}

Umístění komentáře nemění výstup.

Víceřádkové komentáře

Pokud chcete do kódu vložit víceřádkový komentář, můžete jej uvést před nebo za pokyny v kódu. Víceřádkové komentáře se vždy uvádějí pomocí lomítka a hvězdičky. Zde je víceřádkový komentář před pokyny v kódu:

/* In this example there is a multi-line comment.
It starts after the asterisk.
The actual instructions for the computer are under the comment.
This is the last line of this Java comment.
*/
class Main {
public static void main(String[] args) {
System.out.println("This is the text that will be output at the end.");
	}
}

Výstup zní „Toto je text, který bude na konci vypsán.“.

Takto vložíte komentář pod pokyny:

// Example of a multi-line comment below the instructions
class Main {
public static void main(String[] args) {
System.out.println("This is the text that will be output at the end.");
/* In this example there is a multi-line comment.
It starts after the asterisk.
The actual instructions for the computer are above the comment.
This is the last line of this Java comment. */
	}
}

Výstup by měl být stejný jako v předchozím příkladu. Jednořádkový komentář v prvním řádku úryvku kódu nebude také vypsán. Hvězdičku a lomítko můžete umístit přímo za komentář nebo použít samostatný řádek.

Komentáře k dokumentaci

Komentáře v dokumentaci fungují podobně jako blokové komentáře, ale jsou uvedeny lomítkem a dvěma hvězdičkami. To umožňuje dokumentačním nástrojům používat komentáře k vytváření dokumentace. V případě potřeby mohou také obsahovat HTML tagy, jako jsou <h1>, <p> nebo <strong>.

Javadoc, oblíbený nástroj, který můžete použít ke čtení komentářů v dokumentaci, používá také další užitečné tagy. Zde jsou některé z nejdůležitějších: