IL Giava i commenti sono le istruzioni di un programma che non vengono eseguite dal compilatore e dall'interprete.
Perché usiamo i commenti in un codice?
- I commenti vengono utilizzati per rendere il programma più leggibile aggiungendo i dettagli del codice.
- Rende facile mantenere il codice e trovare facilmente gli errori.
- I commenti possono essere utilizzati per fornire informazioni o spiegazioni sul variabile , metodo, classe o qualsiasi affermazione.
- Può anche essere utilizzato per impedire l'esecuzione del codice del programma durante il test del codice alternativo.
Tipi di commenti Java
Esistono tre tipi di commenti in Java.
- Commento a riga singola
- Commento su più righe
- Commento sulla documentazione
1) Commento a riga singola Java
Il commento a riga singola viene utilizzato per commentare solo una riga del codice. È il modo più semplice e ampiamente utilizzato per commentare le dichiarazioni.
I commenti a riga singola iniziano con due barre (//) . Qualsiasi testo davanti a // non viene eseguito da Java.
Sintassi:
//This is single line comment
Usiamo un commento a riga singola in un programma Java.
Commento Esempio1.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 } } Produzione:
10
2) Commento multilinea Java
Il commento su più righe viene utilizzato per commentare più righe di codice. Può essere utilizzato per spiegare un frammento di codice complesso o per commentare più righe di codice alla volta (poiché sarà difficile utilizzare commenti a riga singola in quel caso).
I commenti su più righe vengono inseriti tra /* e */. Qualsiasi testo compreso tra /* e */ non viene eseguito da Java.
Sintassi:
numero di 'Eulero' in Java'
/* This is multi line comment */
Usiamo un commento su più righe in un programma Java.
Commento Esempio2.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 ); */ } } Produzione:
10
Nota: solitamente // viene utilizzato per commenti brevi e /* */ viene utilizzato per commenti più lunghi.
3) Commento sulla documentazione Java
I commenti sulla documentazione vengono solitamente utilizzati per scrivere programmi di grandi dimensioni per un progetto o un'applicazione software poiché aiutano a creare API di documentazione. Queste API sono necessarie come riferimento, ovvero quali classi, metodi, argomenti, ecc. vengono utilizzati nel codice.
Per creare l'API della documentazione, dobbiamo utilizzare il file strumento javadoc . I commenti della documentazione sono inseriti tra /** e */.
Sintassi:
/** * *We can use various tags to depict the parameter *or heading or author name *We can also use HTML tags * */
tag javadoc
Alcuni dei tag comunemente utilizzati nei commenti della documentazione:
| Etichetta | Sintassi | Descrizione |
|---|---|---|
| {@docRoot} | {@docRoot} | per rappresentare il percorso relativo alla directory principale del documento generato da qualsiasi pagina. |
| @autore | @nome autore - testo | Per aggiungere l'autore della classe. |
| @codice | {@testo codice} | Per mostrare il testo nel carattere del codice senza interpretarlo come markup html o tag javadoc nidificato. |
| @versione | @versione versione-testo | Per specificare il sottotitolo 'Versione' e il testo della versione quando viene utilizzata l'opzione -version. |
| @Da | @dal rilascio | Per aggiungere l'intestazione 'Dal' con il testo 'dal' alla documentazione generata. |
| @param | @param descrizione del nome-parametro | Per aggiungere un parametro con il nome e la descrizione specificati nella sezione 'Parametri'. |
| @ritorno | @descrizione del reso | Obbligatorio per ogni metodo che restituisce qualcosa (eccetto void) |
Usiamo il tag Javadoc in un programma Java.
Calcola.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> Compilalo con lo strumento Javac:
Crea documento
Crea API di documentazione tramite javadoc attrezzo:
Ora vengono creati i file HTML per il file Calcolare classe nella directory corrente, ovvero abcDemo . Apri i file HTML e possiamo vedere la spiegazione della classe Calculate fornita attraverso il commento della documentazione.
I commenti Java sono eseguibili?
Anni: Come sappiamo, i commenti Java non vengono eseguiti dal compilatore o dall'interprete, tuttavia, prima della trasformazione lessicale del codice in compilatore, il contenuto del codice viene codificato in ASCII per facilitarne l'elaborazione.
Prova.java
public class Test{ public static void main(String[] args) { //the below comment will be executed // u000d System.out.println('Java comment is executed!!'); } } Produzione:
Il codice precedente genera l'output perché il compilatore analizza il carattere Unicode u000d come un nuova linea prima della trasformazione lessicale, e quindi il codice viene trasformato come mostrato di seguito:
Prova.java
public class Test{ public static void main(String[] args) { //the below comment will be executed // System.out.println('Java comment is executed!!'); } } Pertanto, il carattere Unicode sposta l'istruzione print alla riga successiva e viene eseguita come un normale codice Java.