Reacties zijn een krachtig hulpmiddel . Ze kunnen worden gebruikt om hele application programming interface ( API ) documentatie met tools zoals javadoc genereren , geven kleine hints in lastige delen van code , of gewoon beschrijven wat de code is over te doen . Als u commentaar in Java-code te verlaten, dan kunt u ook laten zien een lezer die niet weet van de taal precies wat de code doet . Instructies
1 Laat korte , enkelvoudige lijn reacties om iets te zeggen snel voor een kleine groep van lijnen . Kleine commentaren overzicht wat er wordt gedaan in het algemeen " brokken . " Een programmeur zal schrijven vaak deze reacties eerst en ga terug naar daarna de code in te vullen , helpt hem om zijn mentale beeld van hoe de code voorafgaand zal werken aan het schrijven ervan , alsook het identificeren van eventuele gebreken in de logica voor het schrijven van de code cement . < br > Pagina 2 Ken de indeling voor het verlaten van een regel commentaar . Ze worden aangeduid door " //" " " //Sluit de ServerSocket s = new TCPSocket ( ) ; s.connect . ( " Example.com " , 80 ) ;//Vraag het files.write ( " GET /HTTP /1.0 \\ r \\ n \\ r \\ n " ) ; snaar reactie = s.read ( ) ;//Was het verzoek succesvol int code = get_code ( respons ) ; ? ! if ( code = 200 ) return -1 ;//Download de filedownload_file ( s ) ; " "
Gebruik multi -line reacties 3 als u meer te zeggen dan er in een enkele lijn te hebben. Multi -line reacties zijn meestal te vinden op de top van methoden beschrijven algemene functie , hoe het werkt en welke parameters er nodig is . Ze zijn soms ook te zien in gelokaliseerde delen van de code van de programmeur had moeite met of denkt warrant diepgaande discussie .
4 Let op de algemene indeling van multi -line opmerkingen. Volgens afspraak , elke lijn begint met een asterisk . De enige specifiek formaat vereisten zijn dat de reactie begint met /* en eindigt met * /. " " /* Dit deel was echt moeilijk . Ik moest * hacken deze waarde aan te passen met de anderen . * Misschien zal ik terugkomen op deze code om * een betere manier om dit te doen vinden , maar voor * nu dit werkt , maar het is niet mooi . * /" "
5 Ken de indeling van Javadoc opmerkingen. Ze beginnen met /** en bevatten meta - tags die er uitzien als @ dit. Javadoc reacties zijn vooral te vinden voordat methoden . " " /*** Berekent de helling van een lijn . ** @ Auteur Jack Smith * @ param p1 eerste punt dat de lijn beschrijft * @ param p2 tweede punt dat de lijn beschrijft * @ return Helling van de lijn als een float * /" "
< br >
|
