Come lasciare commenti nel codice Java

Commenti sono uno strumento potente . Essi possono essere utilizzati per generare intere Application Programming Interface ( API ) documentazione con strumenti come javadoc , dare piccoli suggerimenti in parti difficili del 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 quello che sta facendo il codice . Istruzioni
1

Lascia brevi commenti, a linea singola a dire qualcosa in fretta prima che un piccolo gruppo di linee . Piccolo commenti contorno 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

conosce il formato per lasciare commenti a riga singola . Essi sono noti da "//" " " //Connessione al serverSocket s = new TCPSocket (); s.connect . ( "Example.com" , 80 ) ;//Richiedere la files.write ( "GET /HTTP /1.0 \\ r \\ n \\ r \\ n "); risposta stringa = s.read ( ) ;//è stata la richiesta di successo int codice = get_code (risposta) ; ! if ( codice = 200 ) return -1 ;//Download ? il filedownload_file ( s ) ; ""
3

utilizzare i commenti su più righe quando si ha più da dire di quanto ne entra 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 sono i parametri che ci vuole . Sono anche a volte visto in parti localizzate del codice del programmatore avuto problemi con o pensa mandato in discussione approfondita .
4

Nota Il formato generale di commenti multilinea. Per convenzione , ogni riga inizia con un asterisco . I requisiti di formato solo specifici sono che il commento inizia con /* e termina con * /. "" /* Questa parte è stata davvero dura. Dovevo * hackerare questo valore per adattarsi con gli altri. * Forse tornerò a questo codice per trovare * un modo migliore per fare questo, ma per * Ora questo funziona, ma non è abbastanza . * /" "
5

conosce il formato dei commenti Javadoc . Essi iniziano con /** e contengono meta-tag che assomigliano @ questo . Commenti Javadoc trovano principalmente prima di metodi . "" /*** Calcola la pendenza di una retta . ** @ Autore Jack Smith * @ param P1 Primo punto che descrive la linea * @ param P2 Secondo punto che descrive la linea * @ return Pendenza della linea come un float * /" "

• Come creare Javadoc nel commentare 
• Come usare gli operatori logici in Java