Komentáre v jazyku Java sú nespustiteľné príkazy, ktoré vysvetľujú kód a zlepšujú čitateľnosť. Kompilátor ich ignoruje a neovplyvňujú vykonávanie programu.
- Zlepšite čitateľnosť a udržiavateľnosť kódu.
- Užitočné na ladenie a dokumentovanie logiky.
Java podporuje tri hlavné typy komentárov:
1. Jednoriadkové komentáre
Jednoriadkové komentáre sa používajú na komentovanie jedného riadku kódu.
Syntax:
Java// Komentáre tu (len text v tomto riadku sa považuje za komentár)
// Java program to show single line comments class GFG { public static void main(String args[]) { // Single line comment here System.out.println('Single Line Comment Above'); } }
Výstup
Single Line Comment Above
2. Viacriadkové komentáre
Viacriadkové komentáre sa používajú na opis zložitého kódu alebo metód, pretože písanie viacerých jednoriadkových komentárov môže byť únavné.
Java/*
Komentár sa spustí
pokračuje
pokračuje...
Komentár končí
*/
class GFG { public static void main(String args[]) { System.out.println('Multi Line Comments Below'); /* Comment line 1 Comment line 2 Comment line 3 */ } }
Výstup
Multi Line Comments Below
3. Poznámky k dokumentácii
Komentáre k dokumentácii sa používajú na generovanie externej dokumentácie pomocou Javadoc. Vo všeobecnosti sa používajú v profesionálnych projektoch na popis metód a parametrov tried.
Syntax:
Java/**
* Začiatok komentára
* Popis názvu parametra @param
* Popis @return
*/
/** * * Calculates the average of three integers. * @author Pratik Agarwal * @version 1.0 * @since 2017-02-18 */ public class FindAvg{ /** * Finds average of three integers. * @param numA First parameter * @param numB Second parameter * @param numC Third parameter * @return Average of numA numB and numC */ public int findAvg(int numA int numB int numC) { return (numA + numB + numC) / 3; } /** * Main method which uses findAvg method * @param args Unused */ public static void main(String args[]){ FindAvg obj = new FindAvg(); int avg = obj.findAvg(10 20 30); System.out.println('Average of 10 20 and 30 is: ' + avg); } }
Výstup
Average of 10 20 and 30 is: 20
Súvisiaci článok: nástroj JavaDoc
Oracle sql sa nerovná