La documentazione è una delle cose più importanti è possibile aggiungere durante la scrittura di codice di programmazione. Documentare il vostro programma aggiungendo commenti al codice aiuterà gli altri a capire quello che ogni sezione di codice dovrebbe per compiere all'interno del tuo programma. Anche se si scrive codice che nessuno leggerà, commenti possono aiutarti a ricordare cosa stavi facendo quando si guarda un programma che hai scritto mesi o anni in passato. Ci sono due metodi di inserimento di commenti nel tuo programma Java.
Istruzioni
Singola linea Commenti
1
Aprite il vostro editor di testo. Immettere due caratteri di barra all'inizio di una riga di testo.
2
Inserisci il tuo commento subito dopo le due barre rovesciate. Il tuo commento dovrebbe assomigliare a questo:
Questo è un esempio di un commento a riga singola.
3
Terminare il commento premendo il tasto INVIO sulla tastiera. Il tasto invio termina automaticamente il commento. L'esecuzione di codice verrà ripresa nella riga successiva.
Commenti su più righe
4
Inserire una barra seguita da un asterisco.
5
Inserisci il tuo commento ovunque dopo l'asterisco.
6
Alla fine del tuo commento, immettere un asterisco, seguito da un carattere di barra. Il tuo commento sarà simile a questo:
/*
Questo è un commento che
si estende su più righe.
Questo commento può essere, purché si
Mi piacerebbe farlo.
*/
Consigli & Avvertenze
- I caratteri di delimitazione per Commenti su più righe possono essere utilizzati anche per singola linea commenti. Ad esempio: / * questo è un commento valido * /
- Singola linea commenti utilizzabile in serie per estendersi su più righe.
- Queste sono le
- valido anche
- Commenti.
- È anche possibile utilizzare commenti per debug del codice commentando temporaneamente una linea discutibile o sezione di codice durante il test viene eseguito.