Come commentare in Java?

I comandi sono molto importanti nella programmazione del computer. Queste sono semplici spiegazioni del codice sorgente che rendono il codice sorgente più comprensibile agli umani. Tuttavia, questi non sono considerati dal compilatore o dall'interprete.

Importanza dei commenti

Come discusso in precedenza, i commenti sono necessari perché rendono più comprensibile un programma per computer. I professionisti dei commenti sono elencati di seguito.

• Rende il codice facile da leggere.
• Manutenzione del codice senza sforzo e rilevamento degli errori.
• Fornire dettagli su un determinato metodo, classe, variabile o istruzione.
• Le funzioni scritte per l'uso da altri diventano più facili da capire.

Come in altri linguaggi di programmazione puoi anche scrivere commenti in Java. Questo articolo esplora vari tipi di commenti Java e come usarli insieme ai loro esempi.

Tipi di commenti Java

In Java, ci sono tre approcci al commento come mostrato di seguito.

Commento a riga singola

Per commentare vengono utilizzati commenti a riga singola singola che iniziano con due tagli in avanti. Il testo scritto dopo queste barre in avanti viene ignorato dal compilatore Java.

Ecco la sintassi del commento a linea singola Java:

// Questo è un commento a linea singola

Esempio

Commento multilinea

Quando si desidera commentare più righe nel codice sorgente Java, usa un commento multi-line. Inizia con / * e termina con * /. Il testo scritto tra questi non sarà eseguito dal compilatore Java.

Sintassi

/ * Questo è un commento multi-line */

Esempio

Commento della documentazione

I commenti della documentazione vengono generalmente utilizzati nella creazione di API di documentazione per programmi Java più grandi. Queste API di documentazione vengono utilizzate per fare riferimento a classi, metodi e argomenti utilizzati nel codice sorgente. Inizia con /** e termina con* /.

Ecco la sintassi del tipo di documentazione commento in java.

/**
*
*Per rappresentare i parametri utilizziamo vari tag
*o metodo o intestazione
*Oppure possiamo usare i tag HTML
*
*/

Esempio

La tabella indicata di seguito copre più tipi di tag Javadoc.

Nome tag	Sintassi	Descrizione
@autore	@author name-text	È usato per scrivere il nome dell'autore di una particolare classe.
@versione	@version versione-text	È usato per menzionare il testo della versione.
@param	@Parameter Nome Descrizione	Viene utilizzato per aggiungere il nome e la descrizione dei parametri.
@ritorno	@return Descrizione	Viene utilizzato per trovare facilmente i valori di restituzione facendo una sezione "resi".
@deprecated	@DEPRECATO TESTO DEGRECATO	Viene utilizzato per l'indicazione di una classe o un metodo deprecato o archiviato e crea un avvertimento ogni volta che viene utilizzato da qualcuno.
@Da	@since rilascio	Viene utilizzato per specificare la versione del metodo o della classe ecc. Aggiungendo la sezione "da".
@Throws	@Throws Descrizione Classe-Name	È usato per lanciare un'eccezione.
@eccezione	@Exception Class-Name Descrizione	Ha un uso simile a quello del tag @Throw.
@Vedere	@Vedi riferimento	Viene utilizzato per aggiungere un riferimento a un metodo o una classe generando un collegamento nella sezione "vedi anche".
@seriale	@Serial Field-Description | includere | escludere	Viene utilizzato per aggiungere informazioni pertinenti sui campi serializzati.
@serialfield	@serial-field-name field-field-desscription	Viene utilizzato per documentare il componente ObjectStreamfield.
@serialdata	@serialData Descrizione dei dati	Viene utilizzato per documentare i dati scritti con metodi come WriteObject () o WriteExternal ().
@docroot	@docroot	Viene utilizzato per mostrare il percorso della directory radicale.
@codice	@code text	Viene utilizzato per la visualizzazione del testo nei caratteri del codice.
@valore	pacchetto @Value.Classe#Field	Viene utilizzato per visualizzare il valore della costante quando un commento Doc è scritto in un campo statico.
@inheritdoc	-	È usato per ereditare un commento da una classe ereditabile.
@collegamento	pacchetto @link.Classe#Etichetta membro	Include un collegamento che focalizza la documentazione per un particolare pacchetto, classe o nome membro di una classe a cui si fa riferimento.
@linkplain	@Linkplain pacchetto.Classe#Etichetta membro	Simile al collegamento con l'unica differenza che l'etichetta del collegamento viene visualizzata nel testo semplice anziché nel testo del codice.

Conclusione

Esistono tre tipi di commenti in Java. Il primo è un commento a linea singola che inizia con due barre in avanti '//', il secondo è un commento multilinea che inizia con/ * e termina con */, mentre l'ultimo è un commento di documentazione che viene utilizzato per creare API di documentazione per grandi programmi e applicazioni Java. Tutti questi tipi di commenti sono spiegati in questo tutorial insieme ai tag Javadoc che vengono utilizzati nei commenti della documentazione.