Kommentarer är ett kraftfullt verktyg . De kan användas för att generera hela programmeringsgränssnitt ( API ) dokumentationer med verktyg som javadoc , ge små tips i knepiga delar av koden , eller bara beskriva vad koden är på väg att göra . När du lämnar kommentarer i Java-kod , kan du även visa en läsare som inte vet språket exakt vad koden gör . Instruktioner
1
Lämna korta enradiga kommentarer att säga något snabbt innan en liten grupp av linjer . Små kommentarer skissera vad som görs i allmänhet " bitar . " En programmerare kommer ofta skriver dessa kommentarer först och gå tillbaka för att fylla i koden efteråt , hjälpa honom att befästa sin mentala bild av hur koden fungerar innan du skriver det , samt att identifiera eventuella brister i logik innan du skriver koden .
Sida 2
Vet format för att lämna enradiga kommentarer . De är kända av " //" " " //Anslut till ServerSocket s = ny TCPSocket (); s.connect . ( " Example.com " , 80 ) ;//Begär files.write ( " GET /HTTP /1.0 \\ r \\ n \\ r \\ n " ) ; sträng svar = s.read ( ) ;//Var begäran framgångsrika int code = get_code ( respons ) ; ? ! if ( kod = 200 ) return -1 ;//Ladda ner den filedownload_file ( s ) ; " "
3
använda multi - line kommentarer när du har mer att säga än vad som ryms i en enda rad . Multi - line kommentarer finns vanligen på toppen av metoder som beskriver övergripande funktion , fungerar hur det och vilka parametrar som krävs . De är också ibland ses i lokaliserade delar av koden programmeraren haft problem med eller tänker teckningsoption fördjupad diskussion .
4
Notera allmänna formatet för flera linjer kommentarer . Av konvention börjar varje rad med en asterisk . De enda specifika krav på format är att kommentaren börjar med /* och slutar med * /. " " /* Denna del var riktigt tufft . Jag var tvungen att * hacka detta värde för att passa med de andra. * Kanske jag ska återkomma till denna kod för att * hitta ett bättre sätt att göra detta , men för * nu detta fungerar , men det är inte vackert . * /" "
5
Vet format javadoc kommentarer . De börjar med /** och innehåller meta-taggar som ser ut @ här . Javadoc kommentarer finns främst före metoder . " " /*** Beräknar lutningen på en linje . ** @ Författare Jack Smith * @ param p1 Första punkten som beskriver linjen * @ param p2 andra punkt som beskriver linjen * @ return linjens lutning som en float * /" "
