Ako zanechať komentár v kóde v jazyku Java

Komentáre sú mocným nástrojom . Môžu byť použité na vytvorenie kompletnej rozhranie pre programovanie aplikácií ( API ) Dokumentácia s nástrojmi ako javadoc , dať drobné rady v náročných častí kódu , alebo len popísať , čo kód sa chystá urobiť . Keď necháte komentáre v kóde v jazyku Java , môžete tiež zobraziť čitateľa , ktorý nepozná jazyk , presne to , čo kód robí . Pokyny dovolená 1

Nechajte krátky , jednoriadkový komentuje niečo povedať rýchlo , ako malé skupiny liniek . Malé komentáre načrtnúť , čo sa deje v všeobecné " kúsky " . Programátor bude často písať tieto pripomienky prvý a vrátiť vyplniť v kóde neskôr , mu pomohol upevniť jeho mentálny obraz o tom , ako kód bude fungovať ešte pred jeho písania , rovnako ako identifikovať všetky chyby v logike , ako písanie kódu .

2

vedieť formát pre opustenie jednoriadkové komentáre . Oni sú známi tým , " //" " " //Pripojenie k ServerSocket s = new TCPSocket ( ) ; s.connect . ( " Example.com " , 80 ) ;//Žiadosť o files.write ( " GET /HTTP /1.0 \\ r \\ n \\ r \\ n " ) ; odpoveď string = s.read ( ) ;//Bolo žiadosť úspešnú int code = get_code ( reakcii ) ; ? if (code = 200 ) return -1 ;//download filedownload_file ( y ) " ; "
3

Použitie multi - linka komentuje , keď máte čo povedať , ako sa zmestí do jedného riadku . Multi - linka komentáre sa zvyčajne nachádzajú v hornej časti metód popisujúcich celkovú funkciu , ako to funguje a aké parametre je potreba . Sú tiež niekedy vidieť v lokalizovaných častiach kóde programátor mal problémy s alebo si myslia , že si zaslúžia dôkladnú diskusiu .
4

Poznámka všeobecný formát multi - line komentárov . Podľa konvencie , každý riadok začína s hviezdičkou . Len Osobitné požiadavky na formáte je , že komentár začína /* a končí * /. " " /* Táto časť bola skutočne tvrdá . Musel som * hack túto hodnotu , aby sa zmestili s ostatnými . * Možno sa vrátim k tomuto kódu * nájsť lepší spôsob , ako to urobiť , ale * teraz to funguje , ale nie je to dosť . * /" "
5

vedieť formáte Javadoc komentáre . Začínajú sa /** a obsahuje meta - tagov , ktoré vyzerajú ako @ to . Javadoc komentáre sa nachádzajú hlavne pred metód . " " /*** Vypočíta sklon riadku . ** @ Autor Jack Smith * @ param p1 Prvý bod , ktorý opisuje riadku * @ param p2 Druhý bod , ktorý opisuje riadku * @ return sklon priamky ako float * /" "

• Predchádzajúca strana: Ako vytvoriť Javadoc Pri komentovanie 
• Ďalšia strana: Ako používať logické operátory v jazyku Java