I Java er kommentarer ikke-eksekverbare sætninger, der forklarer kode og forbedrer læsbarheden. De ignoreres af compileren og påvirker ikke programmets udførelse.

• Forbedre kodelæsbarhed og vedligeholdelse.
• Nyttigt til fejlfinding og dokumentation af logik.

Java understøtter tre hovedtyper af kommentarer:

1. Enkeltlinjekommentarer

Enkeltlinjekommentarer bruges til at kommentere en kodelinje.

Syntaks:   

// Kommentarer her (Kun tekst i denne linje betragtes som kommentar)

// 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');   } } 

Single Line Comment Above 

2. Kommentarer med flere linjer

Flerlinjekommentarer bruges til at beskrive kompleks kode eller metoder, da det kan være kedeligt at skrive flere enkeltlinjers kommentarer.

/*
Kommentar starter
fortsætter
fortsætter...
Kommentar slutter
*/

class GFG {  public static void main(String args[])  {   System.out.println('Multi Line Comments Below');    /* Comment line 1  Comment line 2   Comment line 3  */  } } 

Multi Line Comments Below 

3. Dokumentationskommentarer

Dokumentationskommentarer bruges til at generere ekstern dokumentation ved hjælp af Javadoc. De bruges generelt i professionelle projekter til at beskrive klassers metoder og parametre.

Syntaks:   

/**
* Kommentar start
* @param param-navn beskrivelse
* @returbeskrivelse
*/

/**  *   * 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);  } } 

Average of 10 20 and 30 is: 20 

Relateret artikel: JavaDoc værktøj

tyre vs okse