In Java zijn opmerkingen niet-uitvoerbare instructies die code uitleggen en de leesbaarheid verbeteren. Ze worden door de compiler genegeerd en hebben geen invloed op de uitvoering van het programma.

• Verbeter de leesbaarheid en onderhoudbaarheid van code.
• Handig voor het debuggen en documenteren van logica.

Java ondersteunt drie hoofdtypen opmerkingen:

1. Opmerkingen van één regel

Enkelregelig commentaar wordt gebruikt om commentaar te geven op één regel code.

Syntaxis:   

// Commentaar hier(Alleen tekst op deze regel wordt beschouwd als commentaar)

// 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. Commentaar met meerdere regels

Meerregelig commentaar wordt gebruikt om complexe code of methoden te beschrijven, omdat het schrijven van meerdere enkelregelig commentaar vervelend kan zijn.

/*
Commentaar begint
gaat door
vervolgt...
Reactie eindigt
*/

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. Documentatieopmerkingen

Documentatieopmerkingen worden gebruikt om externe documentatie te genereren met behulp van Javadoc. Ze worden over het algemeen gebruikt in professionele projecten om klassenmethoden en parameters te beschrijven.

Syntaxis:   

/**
* Commentaar begint
* @param paramnaambeschrijving
* @retourbeschrijving
*/

/**  *   * 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 

Gerelateerd artikel: JavaDoc-tool

round robin-planningsalgoritme