Opmerkingen gebruiken in Java-code

Java-opmerkingen zijn opmerkingen in een Java-codebestand die worden genegeerd door de compiler en runtime-engine. Ze worden gebruikt om de code te annoteren om het ontwerp en het doel ervan te verduidelijken. U kunt een onbeperkt aantal opmerkingen toevoegen aan een Java-bestand, maar er zijn enkele "best practices" die u moet volgen bij het gebruik van opmerkingen.

Over het algemeen zijn codecommentaren "implementatie" -commentaren die de broncode, zoals beschrijvingen van klassen, interfaces, methoden en velden. Dit zijn meestal een paar regels die boven of naast Java-code zijn geschreven om te verduidelijken wat het doet.

Een ander type Java-opmerking is een Javadoc-opmerking. Javadoc-opmerkingen verschillen enigszins in syntaxis van implementatie-opmerkingen en worden gebruikt door het programma javadoc.exe om Java HTML-documentatie te genereren.

Het is een goede gewoonte om er een gewoonte van te maken om Java-opmerkingen in uw broncode te plaatsen om de leesbaarheid en duidelijkheid voor uzelf en andere programmeurs te verbeteren. Het is niet altijd meteen duidelijk wat een sectie van Java-code presteert. Een paar verklarende regels kunnen de tijd die het kost om de code te begrijpen drastisch verminderen.

Implementatie opmerkingen in Java-code zijn er alleen voor mensen om te lezen. Java-compilers geven er niet om en wanneer het compileren van het programma, ze slaan ze gewoon over. De grootte en efficiëntie van uw gecompileerde programma wordt niet beïnvloed door het aantal opmerkingen in uw broncode.

Opmerkingen over implementatie zijn er in twee verschillende formaten:

• Regelcommentaar: Typ "//" voor een opmerking van één regel en volg de twee voorwaartse schuine strepen met uw opmerking. Bijvoorbeeld:

   // Dit is een commentaar van één regel
  int radennummer = (int) (Math.random () * 10); 

  Wanneer de compiler de twee voorwaartse schuine strepen tegenkomt, weet hij dat alles rechts ervan als commentaar moet worden beschouwd. Dit is handig bij het debuggen van een stuk code. Voeg gewoon een opmerking toe uit een regel code die u debugt, en de compiler zal het niet zien:

  •  // Dit is een commentaar van één regel
    // int radenNummer = (int) (Math.random () * 10); 

    U kunt ook de twee schuine strepen naar voren gebruiken om een ​​opmerking aan het einde van de regel te plaatsen:

  •  // Dit is een commentaar van één regel
    int radennummer = (int) (Math.random () * 10); // Een opmerking aan het einde van de regel 

• Blokkeer opmerkingen: Typ "/ *" om een ​​blokcommentaar te starten. Alles tussen de schuine streep naar voren en het sterretje, zelfs als het op een andere regel staat, wordt behandeld als een opmerking totdat de tekens "* /" de opmerking beëindigen. Bijvoorbeeld:

   /* deze 
  is 
  een
  blok
  commentaar
  */
  / * zo is dit * /
  

Gebruik speciale Javadoc-opmerkingen om uw Java-API te documenteren. Javadoc is een tool die bij de JDK wordt geleverd en HTML-documentatie genereert op basis van opmerkingen in de broncode.

Een Javadoc-opmerking in

.Java

/**

*/

*

Plaats deze opmerkingen direct boven de methode, klasse, constructor of elk ander Java-element dat u wilt documenteren. Bijvoorbeeld:

// myClass.java
/**
* Maak dit een samenvattende zin die uw klas beschrijft.
* Hier is nog een regel.
*/
openbaarklasse mijn klas
{
...
}

Javadoc bevat verschillende tags die bepalen hoe de documentatie wordt gegenereerd. Bijvoorbeeld de

@param

 / ** belangrijkste methode
* @param args String []
*/​
openbaarstatischnietig main (String [] args)
​{
System.out.println ("Hallo wereld!");
}

Veel andere tags zijn beschikbaar in Javadoc en het ondersteunt ook HTML-tags om de uitvoer te helpen regelen. Zie uw Java-documentatie voor meer details.

• Geef geen commentaar. Elke regel van uw programma hoeft niet te worden uitgelegd. Als uw programma logisch stroomt en er zich niets onverwachts voordoet, hoeft u geen commentaar toe te voegen.
• Laat uw opmerkingen inspringen. Als de coderegel die u plaatst, is ingesprongen, zorg er dan voor dat uw opmerking overeenkomt met de inspringing.
• Houd opmerkingen relevant. Sommige programmeurs zijn uitstekend in het wijzigen van code, maar vergeten om een ​​of andere reden de opmerkingen bij te werken. Als een opmerking niet meer van toepassing is, wijzig of verwijder deze dan.
• Nest blok opmerkingen niet. Het volgende resulteert in een compileerfout:

   /* deze 
  is
  / * Deze blokcommentaar beëindigt de eerste opmerking * /
  een
  blok
  commentaar
  */