I commenti sono un potente strumento. Essi può essere utilizzati per generare l'intera applicazione programmazione documentazioni di interfaccia (API) con strumenti come javadoc, dare piccoli accenni in parti difficili del codice o semplicemente descrivere ciò che il codice è in procinto di fare. Quando si lasciano commenti nel codice Java, è possibile mostrare anche un lettore che non conosce la lingua esattamente che cosa fa il codice.

Istruzioni

1

Lasciare commenti brevi, riga singola per dire qualcosa rapidamente prima che un piccolo gruppo di linee. Piccole osservazioni delineano ciò che è stato fatto in generale "blocchi". Un programmatore sarà spesso scrivere questi commenti prima e tornare a compilare il codice in seguito, aiutandolo a cementare la sua immagine mentale di come il codice funzionerà prima di scriverlo, nonché di individuare eventuali difetti nella logica prima di scrivere il codice.

2

Conoscere il formato per lasciare commenti a riga singola. Sono notati da "/ /".""// Connect to the server
Socket s = new TCPSocket();
s.connect("example.com", 80);// Request the file
s.write("GET / HTTP/1.0\r\n\r\n");
string response = s.read();// Was the request successful?
int code = get_code(response);
if( code != 200 ) return -1;// Download the file
download_file(s);""

3

Utilizzare Commenti su più righe quando si dispone di più per dire che si adatta in una singola riga. Commenti su più righe si trovano di solito nella parte superiore di metodi che descrivono la funzione generale, come funziona e quali parametri ci vuole. Sono anche a volte visto in parti localizzate del codice che il programmatore ha avuto problemi con, o pensa che garantiscono discussione approfondita.

4

Nota il formato generale di commenti a più righe. Per convenzione, ogni riga inizia con un asterisco. I requisiti di formato solo specifico sono che il commento inizia con / e finisce con /.""/ This part was really tough. I had to
hack this value to fit with the others.
Maybe I'll come back to this code to
find a better way to do this, but for
now this works, but it's not pretty.
/""

5

Conosce il formato dei commenti Javadoc. Cominciano con / e contengono i meta-tag che assomigliano a @this. Commenti Javadoc si trovano principalmente prima di metodi.
""/
Computes the slope of a line.

@Author Jack Smith
@param p1 First point that describes the line
@param p2 Second point that describes the line
@return Slope of the line as a float
*/""

Consigli & Avvertenze

• Sviluppare un equilibrio di commenti durante la scrittura del codice. Troppi commenti in realtà rende il codice più difficile da leggere. Quando il codice è facile da seguire, non esiste nessun punto nella scrittura di commenti per ogni linea. A altro estremo, il codice con nessun commento può essere difficile da leggere se il lettore non capisce pienamente che cosa fa il codice.
• In Java, vedete anche meta-tag di javadoc in Commenti su più righe.