Kommentarer er et kraftfuldt værktøj. De kan bruges til at generere hele Application Programming Interface (API) dokumentationer med værktøjer som javadoc , gives små hints i vanskelige dele af koden , eller bare beskrive, hvad koden er ved at gøre. Når du forlader kommentarer i Java-kode , kan du også vise en læser , der ikke kender sproget , hvad koden gør. Instruktioner
1
Efterlad korte, single -line kommentarer at sige noget hurtigt, før en lille gruppe af linjer. Små kommentarer skitsere , hvad der bliver gjort i generelle " bidder ". En programmør vil ofte skriver disse kommentarer først , og gå tilbage for at udfylde koden bagefter , hjælpe ham til at cementere hans mentale billede af, hvordan koden vil arbejde forud for at skrive det , samt identificere eventuelle mangler i logik inden skrivning af kode. < br >
2
Kend format for at forlade enkelt linje kommentarer . De er noteret med " //" "" //Forbind til ServerSocket s = new TCPSocket (); s.connect . ( " Example.com " , 80) ;//Anmod files.write ( "GET /HTTP /1.0 \\ r \\ n \\ r \\ n "); string respons = s.read () ;//Var anmodningen succesfulde int code = get_code ( respons ); ! if ( code = 200 ) return -1 ;//Hent den filedownload_file (s), ""
3
flere linjer kommentarer , når du har mere at sige end vil passe ind i en enkelt linje. Multi -line kommentarer er normalt findes i toppen af metoder beskriver overordnede funktion , hvordan det fungerer , og hvilke parametre det tager. De er også nogle gange ses i lokaliserede dele af koden programmøren havde problemer med eller tænker warrant dybdegående diskussion.
4
Bemærk den almindelige opstilling af flere linjer bemærkninger. Pr. konvention begynder hver linje med en stjerne. De eneste specifikke krav til formatet er , at den kommentar begynder med /* og slutter med * /. "" /* Denne del var virkelig hård. Jeg måtte * hacke denne værdi til at passe med de andre. * Måske vil jeg vende tilbage til denne kode til * finde en bedre måde at gøre dette , men for * Nu dette virker, men det er ikke kønt . * /""
5
Kend format javadoc kommentarer . De begynder med /** og indeholder meta-tags , der ligner @ dette. Javadoc kommentarer er hovedsageligt findes inden metoder. "" /*** Beregner hældningen af en linje. ** @ Forfatter Jack Smith * @ param p1 Første punkt , der beskriver linjen * @ param p2 Andet punkt , der beskriver linjen * @ return hældning som float * /""
< br >