El Java els comentaris són les sentències d'un programa que no són executades pel compilador i l'intèrpret.
Per què fem servir comentaris en un codi?
- Els comentaris s'utilitzen per fer el programa més llegible afegint els detalls del codi.
- Fa fàcil mantenir el codi i trobar els errors fàcilment.
- Els comentaris es poden utilitzar per proporcionar informació o explicació sobre el variable , mètode, classe , o qualsevol declaració.
- També es pot utilitzar per evitar l'execució del codi del programa mentre es prova el codi alternatiu.
Tipus de comentaris de Java
Hi ha tres tipus de comentaris a Java.
- Comentari d'una sola línia
- Comentari de diverses línies
- Comentari de documentació
1) Comentari d'una sola línia de Java
El comentari d'una sola línia s'utilitza per comentar només una línia del codi. És la manera molt utilitzada i més fàcil de comentar les declaracions.
Els comentaris d'una sola línia comencen amb dues barres inclinades (//) . Qualsevol text davant de // no és executat per Java.
Sintaxi:
//This is single line comment
Utilitzem el comentari d'una sola línia en un programa Java.
CommentExample1.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 } } Sortida:
10
2) Comentari de múltiples línies de Java
El comentari de diverses línies s'utilitza per comentar diverses línies de codi. Es pot utilitzar per explicar un fragment de codi complex o per comentar diverses línies de codi alhora (ja que hi serà difícil utilitzar comentaris d'una sola línia).
Els comentaris de diverses línies es col·loquen entre /* i */. Qualsevol text entre /* i */ no és executat per Java.
Sintaxi:
exemples d'arbres binaris
/* This is multi line comment */
Utilitzem el comentari de diverses línies en un programa Java.
CommentExample2.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 ); */ } } Sortida:
10
Nota: normalment // s'utilitza per a comentaris curts i /* */ s'utilitza per a comentaris més llargs.
3) Comentari de documentació Java
Els comentaris de documentació s'utilitzen normalment per escriure programes grans per a un projecte o aplicació de programari, ja que ajuden a crear API de documentació. Aquestes API són necessàries per a la referència, és a dir, quines classes, mètodes, arguments, etc. s'utilitzen al codi.
Per crear l'API de documentació, hem d'utilitzar eina javadoc . Els comentaris de documentació es col·loquen entre /** i */.
Sintaxi:
/** * *We can use various tags to depict the parameter *or heading or author name *We can also use HTML tags * */
etiquetes javadoc
Algunes de les etiquetes que s'utilitzen habitualment als comentaris de la documentació:
| Etiqueta | Sintaxi | Descripció |
|---|---|---|
| {@docRoot} | {@docRoot} | per representar el camí relatiu al directori arrel del document generat des de qualsevol pàgina. |
| @autor | @nom de l'autor - text | Per afegir l'autor de la classe. |
| @codi | {@code text} | Per mostrar el text en font de codi sense interpretar-lo com a marcatge html o etiqueta javadoc imbricada. |
| @versió | @versió versió-text | Per especificar el subtítol 'Versió' i el text de la versió quan s'utilitza l'opció -version. |
| @des que | @des del llançament | Per afegir l'encapçalament 'Des de' amb text des de la documentació generada. |
| @param | @param descripció del nom del paràmetre | Per afegir un paràmetre amb nom i descripció a la secció 'Paràmetres'. |
| @retorn | @return descripció | Necessari per a tots els mètodes que retornin alguna cosa (excepte void) |
Utilitzem l'etiqueta Javadoc en un programa Java.
Calculate.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> Compileu-lo amb l'eina javac:
Crear document
Creeu l'API de documentació per javadoc eina:
Ara, els fitxers HTML es creen per a Calcular classe al directori actual, és a dir, abcDemo . Obriu els fitxers HTML i podrem veure l'explicació de la classe Calculate proporcionada a través del comentari de documentació.
Els comentaris de Java són executables?
Anys: Com sabem, els comentaris de Java no són executats pel compilador o intèrpret, però, abans de la transformació lèxica del codi al compilador, el contingut del codi es codifica en ASCII per tal de facilitar el processament.
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!!'); } } Sortida:
El codi anterior genera la sortida perquè el compilador analitza el caràcter Unicode u000d com un nova línia abans de la transformació lèxica i, per tant, el codi es transforma tal com es mostra a continuació:
Test.java
public class Test{ public static void main(String[] args) { //the below comment will be executed // System.out.println('Java comment is executed!!'); } } Així, el caràcter Unicode desplaça la instrucció d'impressió a la línia següent i s'executa com un codi Java normal.