Kommentarer er et kraftig verktøy. De kan brukes til å generere hele programmeringsgrensesnitt (API ) dokumentasjoner med verktøy som javadoc , gi små hint i vanskelige deler av koden , eller bare beskrive hva koden er i ferd med å gjøre. Når du legge inn kommentarer i Java-kode , kan du også vise en leser som ikke kjenner språket nøyaktig hva koden gjør. Instruksjoner
en
Leave korte, én linje kommentarer å si noe raskt før en liten gruppe av linjer . Små kommentarer disposisjon hva som blir gjort i generelle " biter ". En programmerer vil ofte skrive disse kommentarene først og gå tilbake for å fylle i koden etterpå , hjelpe ham til å sementere hans mentale bilde av hvordan koden vil fungere før du skriver det , samt identifisere eventuelle feil i logikken før du skriver koden .
2
Kjenn format for å forlate én linje kommentarer . De er merket med " //" "" //Koble til ServerSocket s = new TCPSocket (); s.connect . ( " Example.com " , 80 ) ;//Be om files.write ( " GET /HTTP /1.0 \\ r \\ n \\ r \\ n "); string response = s.read ( ) ;//Var forespørselen vellykket int kode = get_code ( respons) ; ? ! if ( kode = 200 ) return -1 ;//Last ned den filedownload_file ( s ) ; ""
3
Bruk flere linjer kommentarer når du har mer å si enn det er plass i en enkelt linje. Multi-line kommentarer finnes vanligvis på toppen av metoder som beskriver generelle funksjon, fungerer hvordan det og hvilke parametre som skal til. De er også noen ganger sett i lokaliserte deler av koden programmerer hadde problemer med eller tenker garanterer grundig diskusjon .
4
merke til generelle formatet for flere linjer kommentarer . Ved konvensjonen , begynner hver linje med en stjerne. De eneste konkrete krav format er at kommentaren begynner med /* og slutter med * /. "" /* Denne delen var veldig tøft . Jeg måtte * hacke denne verdien til å passe med de andre. * Kanskje jeg kommer tilbake til denne koden til * finne en bedre måte å gjøre dette på , men for * nå dette fungerer , men det er ikke pent. * /" "
5
Vet formatet på javadoc kommentarer . De begynner med /** og inneholder meta -tags som ser ut som @ dette. Javadoc kommentarer er hovedsakelig funnet før metoder. "" /*** Beregner skråningen av en linje. ** @ Forfatter Jack Smith * @ param p1 Første punkt som beskriver linjen * @ param p2 Andre punkt som beskriver linjen * @ return Slope av linjen som en dupp * /" "