Come si scrive un commento Javadoc?

“I commenti svolgono un ruolo molto vitale nella propria vita, io.e., per farli aggiornare il loro stile di vita e tutto ciò che riguardava. Ci sono principalmente due tipi di commenti, io.e., Commenti a linea singola e commenti multi-line. Ma c'è un altro tipo di commento che di solito non impariamo, io.e., Commenti di Javadoc. I commenti Javadoc sono generalmente noti tra gli sviluppatori Java e possono essere generati automaticamente dal JDK del programma e non è necessario creare i tuoi commenti. Un programma chiamato Javadoc è incluso con il JDK ed è impiegato per generare una descrizione HTML del codice Java tramite Java Language Source, che richiede la documentazione in modo predeterminato. In questo tutorial, darà un'occhiata ai commenti Javadoc nella programmazione Java utilizzando lo strumento Java nel sistema Windows."

Sintassi

In primo luogo, dobbiamo vedere la sintassi di base dei commenti Javadoc in Java. Quindi, abbiamo usato il semplice editor per inserire alcuni commenti Javadoc e visualizzarne la presentazione di seguito nell'immagine allegata. Il commento autogenerato del documento Java inizia con un personaggio speciale come un asterisco e la prima riga dell'intero commento potrebbe essere il colore verde. Puoi vedere la rappresentazione di un commento del documento Java che ha molti personaggi di Asterisk all'inizio di ogni commento dall'inizio alla fine.

All'inizio, il commento di Java Doc inizia con il personaggio "/" seguito da due personaggi di Asterisk. Allo stesso tempo, tutte le altre righe contengono un singolo carattere di asterisco al loro inizio. Alla fine di un commento del documento Java, l'abbiamo concluso con il personaggio "/". Tra questo illustrazione di commento del documento Java, vedrai una riga di commento "7" in cui abbiamo definito il nome di un autore usando il personaggio "@" per definire un "autore" variabile con il nome di un autore di commenti,.e., Saeed Raza. Le informazioni sui metadati dei commenti del documento Java devono sempre essere scritte con il personaggio "@".

Crea un commento automatico java doc in eclipse IDE

Questo esempio utilizza l'ambiente Eclipse IDE JAVA Development per creare commenti automatici nel progetto Java. Per questo, devi avere un IDE ECLIPSE montato e impostato alla fine. Quindi, lancia l'IDE Eclipse e prova a creare un nuovo progetto chiamato "Java". Ti chiederà di nominare il pacchetto di progetto corrente. L'abbiamo chiamato anche "Java". Successivamente, è necessario creare un nuovo file Java o creare una nuova classe all'interno dello stesso progetto Java. Per questo, toccare destro sul nome del pacchetto dall'angolo sinistro della barra Explorer del progetto IDE ECLIPSE, passare alla "nuova" opzione e premere la parola chiave "classe" dalle opzioni ampliate. Questo genererà una nuova finestra sullo schermo con il titolo "New Java Class", come visualizzato nell'immagine qui sotto.

Ora, devi inserire il nome di una classe da creare all'interno della casella di testo di fronte all'etichetta "Nome". La maggior parte delle cose rimarrà invariata in quanto sono state selezionate automaticamente ogni volta che si tenta di creare una nuova classe. Devi solo cancellare la fine del metodo che desideri creare per il tuo codice Java. Pertanto, abbiamo verificato la prima casella di controllo per creare una funzione driver principale () in questa classe. Ultimo ma non meno importante, troverai l'opportunità di aggiungere i commenti predefiniti nel programma Java da creare. Devi solo controllare la casella di controllo denominata "Genera commenti". Questo sarà un passo fenomenale nella creazione del codice Java. Premiamo il pulsante "finitura" dopo aver fornito tutte le informazioni necessarie.

Il programma Java a cinghia mostrato è stato creato nello strumento Eclipse IDE insieme a commenti automatici. Puoi vedere che i commenti di Java Doc sono tutti iniziati con i personaggi di Asterisk. Fornisce inoltre informazioni sui metadati riguardanti il ​​progetto, i.e., l'autore. Insieme a ciò, mostra anche il commento automatico raffigura che abbiamo creato anche una funzione principale di stub. Si tratta della generazione automatica di commenti Javadoc in Eclipse IDE.

Esempio 01: Commenti Javadoc

Ora puoi creare i tuoi commenti di documento Java durante la programmazione. Ecco un'altra illustrazione per farlo. Ogni volta che hai utilizzato la funzione driver principale () nel codice, io.e., Avresti dovuto usarlo in ogni singolo programma, dovresti sempre creare il suo commento nella parte superiore del file o, all'interno di questa funzione, iniziare come "// Todo Method Generated Method Stub". Questo commento spiega che il metodo principale () è stato generato automaticamente, i.e., Non hai bisogno di scriverlo.

Dopo questo, abbiamo aggiunto un commento di Javadoc Long che elabora l'uso di questo programma insieme alle sue informazioni sui metadati, i.e., autore, versione e data in cui è stato creato. Prima dell'istruzione "println", è utilizzata una singola riga di commenti per spiegare lo scopo di utilizzare la funzione println (). Questo è tutto per questo esempio.

L'esecuzione di programmi con commenti non influisce sull'output come di seguito.

Esempio 01: commenti a linea singola e multilina

Dopo aver attraversato i commenti di Javadoc in Eclipse IDE, iniziamo a dare un'occhiata a un altro esempio di Java che utilizza i commenti a linea singola e multiline.e., definito dall'utente. Ora abbiamo generato un nuovo "test" di classe e abbiamo incluso il metodo principale (). Questo metodo contiene un'istruzione funzione println () per visualizzare qualcosa. Abbiamo utilizzato un commento a linea singola con il nome di una classe che inizia con i personaggi "//", io.e., spiega che è l'inizializzazione della classe. Nella riga di definizione della funzione principale () ha aggiunto un commento multiline.

Conclusione

Questo articolo ti aiuta a capire l'importanza e la vitalità dei commenti utilizzati nella vita quotidiana e nella vita di programmazione. Discute come questi commenti possono aiutarti in molti modi. In primo luogo, abbiamo discusso di quali sono i commenti di Javadoc e spiegato molto brevemente la loro sintassi. Dopo questo, abbiamo spiegato l'intero metodo in Eclipse IDE per generare i commenti automatici Javadoc in pochi secondi e con alcuni clic sulla GUI.