Come lasciare commenti nel codice Java

March 16

I commenti sono uno strumento potente. Essi possono essere utilizzati per generare tutta l'interfaccia di programmazione delle applicazioni (API) documentazione con strumenti come javadoc, dare piccoli suggerimenti in parti difficili di codice, o semplicemente descrivere ciò che il codice sta per fare. Quando si lascia commenti nel codice Java, si può anche mostrare un lettore che non conosce la lingua esattamente ciò che il codice sta facendo.

istruzione

1 Lascia brevi commenti a riga singola di dire rapidamente qualcosa prima di un piccolo gruppo di linee. Piccole commenti delineano ciò che è stato fatto in generale "blocchi". Un programmatore 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é individuare eventuali difetti nella logica prima di scrivere il codice.

2 Conoscere il formato per lasciare commenti a riga singola. Essi sono noti 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);""
""// 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 ha altro da dire che si adatta in una sola riga. commenti su più righe si trovano di solito nella parte superiore di metodi che descrivono la funzione generale, come funziona e quali parametri che ci vuole. Sono anche a volte visto in alcune parti localizzate del codice del programmatore avuto problemi con o pensa mandato di discussione approfondita.

4 Notare il formato generale di commenti su più righe. Per convenzione, ogni riga inizia con un asterisco. Gli unici requisiti formato specifico sono che il commento inizia con /

e termina 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.
/""
""/ 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 Conoscere il formato dei commenti Javadoc. Cominciano con / e contengono meta-tag che sembrano @This. Commenti Javadoc si trovano principalmente prima di metodi.
""/

Calcola la pendenza di una retta.

@Author Jack Smith
@param P1 Primo punto che descrive la linea
@param P2 Secondo punto che descrive la linea
Pendenza @return della linea come un galleggiante
* / ""

Consigli e avvertenze

  • Sviluppare un equilibrio di commenti durante la scrittura di codice. Troppi commenti in realtà rende il codice più difficile da leggere. Quando il codice è facile da seguire, non ha senso per iscritto commenti per ogni linea. All'altro estremo, il codice con commenti può essere difficile da leggere se il lettore non comprendere appieno ciò che il codice sta facendo.
  • In Java, si vede anche javadoc meta-tag nei commenti multilinea.

Articoli Correlati