De Java commentaren zijn de instructies in een programma die niet worden uitgevoerd door de compiler en tolk.
Waarom gebruiken we commentaar in een code?
- Commentaar wordt gebruikt om het programma leesbaarder te maken door de details van de code toe te voegen.
- Het maakt het gemakkelijk om de code te onderhouden en de fouten gemakkelijk te vinden.
- De opmerkingen kunnen worden gebruikt om informatie of uitleg te geven over de variabel , methode, klas , of welke verklaring dan ook.
- Het kan ook worden gebruikt om de uitvoering van programmacode te voorkomen tijdens het testen van de alternatieve code.
Soorten Java-opmerkingen
Er zijn drie soorten opmerkingen in Java.
- Enkele regel commentaar
- Commentaar met meerdere regels
- Documentatie Opmerking
1) Java-commentaar met één regel
Het commentaar van één regel wordt gebruikt om slechts één regel van de code te becommentariëren. Het is de meest gebruikte en gemakkelijkste manier om de uitspraken te becommentariëren.
Commentaar op één regel begint met twee schuine strepen (//) . Tekst vóór // wordt niet door Java uitgevoerd.
Syntaxis:
//This is single line comment
Laten we commentaar van één regel gebruiken in een Java-programma.
CommentaarVoorbeeld1.java
public class CommentExample1 { public static void main(String[] args) { int i=10; // i is a variable with value 10 System.out.println(i); //printing the variable i } }
Uitgang:
10
2) Java-commentaar met meerdere regels
Het meerregelige commentaar wordt gebruikt om meerdere regels code te becommentariëren. Het kan worden gebruikt om een complex codefragment uit te leggen of om meerdere regels code tegelijk te becommentariëren (aangezien het moeilijk zal zijn om daar commentaar van één regel te gebruiken).
Commentaar met meerdere regels wordt tussen /* en */ geplaatst. Tekst tussen /* en */ wordt niet door Java uitgevoerd.
Syntaxis:
round robin-planningsalgoritme
/* This is multi line comment */
Laten we commentaar met meerdere regels gebruiken in een Java-programma.
CommentaarVoorbeeld2.java
public class CommentExample2 { public static void main(String[] args) { /* Let's declare and print variable in java. */ int i=10; System.out.println(i); /* float j = 5.9; float k = 4.4; System.out.println( j + k ); */ } }
Uitgang:
10
Opmerking: Meestal wordt // gebruikt voor korte commentaren en /* */ voor langere commentaren.
3) Java-documentatiecommentaar
Documentatieopmerkingen worden meestal gebruikt om grote programma's voor een project of softwaretoepassing te schrijven, omdat dit helpt bij het creëren van documentatie-API. Deze API's zijn nodig ter referentie, dat wil zeggen welke klassen, methoden, argumenten, enz. in de code worden gebruikt.
Om de documentatie-API te maken, moeten we de Javadoc-tool . De opmerkingen bij de documentatie worden tussen /** en */ geplaatst.
Syntaxis:
/** * *We can use various tags to depict the parameter *or heading or author name *We can also use HTML tags * */
javadoc-tags
Enkele veelgebruikte tags in documentatiecommentaar:
Label | Syntaxis | Beschrijving |
---|---|---|
{@docRoot} | {@docRoot} | om het relatieve pad naar de hoofdmap van het gegenereerde document vanaf elke pagina weer te geven. |
@auteur | @auteurnaam - tekst | Om de auteur van de klasse toe te voegen. |
@code | {@codetekst} | Om de tekst in codelettertype weer te geven zonder deze te interpreteren als HTML-opmaak of geneste Javadoc-tag. |
@versie | @versie versie-tekst | Om de subkop 'Versie' en versietekst op te geven wanneer de optie -version wordt gebruikt. |
@sinds | @sinds release | Om de kop 'Sinds' met sinds-tekst toe te voegen aan de gegenereerde documentatie. |
@param | @param parameternaambeschrijving | Om een parameter met de opgegeven naam en beschrijving toe te voegen aan de sectie 'Parameters'. |
@opbrengst | @retourbeschrijving | Vereist voor elke methode die iets retourneert (behalve void) |
Laten we de Javadoc-tag gebruiken in een Java-programma.
Bereken.java
import java.io.*; /** * <h2> Calculation of numbers </h2> * This program implements an application * to perform operation such as addition of numbers * and print the result * <p> * <b>Note:</b> Comments make the code readable and * easy to understand. * * @author Anurati * @version 16.0 * @since 2021-07-06 */ public class Calculate{ /** * This method calculates the summation of two integers. * @param input1 This is the first parameter to sum() method * @param input2 This is the second parameter to the sum() method. * @return int This returns the addition of input1 and input2 */ public int sum(int input1, int input2){ return input1 + input2; } /** * This is the main method uses of sum() method. * @param args Unused * @see IOException */ public static void main(String[] args) { Calculate obj = new Calculate(); int result = obj.sum(40, 20); System.out.println('Addition of numbers: ' + result); } } </p>
Compileer het met de javac-tool:
Document maken
Documentatie-API maken door javadoc hulpmiddel:
Nu worden de HTML-bestanden gemaakt voor de Berekenen klasse in de huidige map, d.w.z. abcDemo . Open de HTML-bestanden en we kunnen de uitleg van de Calculate-klasse zien die wordt gegeven via het documentatiecommentaar.
Zijn Java-opmerkingen uitvoerbaar?
Jaren: Zoals we weten, worden Java-opmerkingen niet uitgevoerd door de compiler of tolk, maar vóór de lexicale transformatie van de code in de compiler wordt de inhoud van de code gecodeerd in ASCII om de verwerking eenvoudig te maken.
Test.java
public class Test{ public static void main(String[] args) { //the below comment will be executed // u000d System.out.println('Java comment is executed!!'); } }
Uitgang:
De bovenstaande code genereert de uitvoer omdat de compiler het Unicode-teken parseert u000d als een nieuwe lijn vóór de lexicale transformatie, en dus wordt de code getransformeerd zoals hieronder weergegeven:
Test.java
public class Test{ public static void main(String[] args) { //the below comment will be executed // System.out.println('Java comment is executed!!'); } }
Het Unicode-teken verschuift dus de print-instructie naar de volgende regel en wordt uitgevoerd als een normale Java-code.