V Javi so komentarji neizvršljivi stavki, ki pojasnjujejo kodo in izboljšujejo berljivost. Prevajalnik jih ignorira in ne vplivajo na izvajanje programa.
- Izboljšajte berljivost in vzdržljivost kode.
- Uporabno za odpravljanje napak in dokumentiranje logike.
Java podpira tri glavne vrste komentarjev:
1. Enovrstični komentarji
Enovrstični komentarji se uporabljajo za komentiranje ene vrstice kode.
Sintaksa:
Java// Komentarji tukaj (samo besedilo v tej vrstici velja za komentar)
// 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'); } }
Izhod
Single Line Comment Above
2. Večvrstični komentarji
Večvrstični komentarji se uporabljajo za opis kompleksne kode ali metod, saj je lahko pisanje več enovrstičnih komentarjev dolgočasno.
Java/*
Komentar se začne
nadaljuje
nadaljuje ...
Komentar se konča
*/
class GFG { public static void main(String args[]) { System.out.println('Multi Line Comments Below'); /* Comment line 1 Comment line 2 Comment line 3 */ } }
Izhod
Multi Line Comments Below
3. Pripombe k dokumentaciji
Komentarji dokumentacije se uporabljajo za ustvarjanje zunanje dokumentacije z uporabo Javadoc. Na splošno se uporabljajo v profesionalnih projektih za opis metod in parametrov razredov.
Sintaksa:
Java/**
* Začetek komentarja
* @param param-name opis
* @return opis
*/
/** * * 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); } }
Izhod
Average of 10 20 and 30 is: 20
Sorodni članek: orodje JavaDoc
kaj je samodejno ožičeno v Javi