Adăugarea de comentarii la codul Java - dummies

Această listare Java are o versiune îmbunătățită a unui program de probă. Pe lângă toate cuvintele cheie, identificatorii și semnele de punctuație, textul este destinat citirii ființelor umane.

/ * * Listarea 3-6 în "Java For Dummies, ediția a 6-a" * * Copyright 2014 Wiley Publishing, Inc. * Toate drepturile rezervate. * / / ** * Clasa Displayer afișează text * pe ecranul computerului. * * @author Barry Burd * @version 1. 0 10/24/13 * @see java. lang. Sistem * / public Displayer clasa {/ ** * Metoda principală este locul în care * începe executarea codului. * * @param args (Vezi capitolul 11.) * / public static void main (String args []) {System. out. println ("Îmi place Java!"); // I? Sunteți?}}

Un comentariu este o secțiune specială a textului dintr-un program al cărui scop este de a ajuta oamenii să înțeleagă programul. Un comentariu face parte dintr-o documentație a unui program bun.

Limba de programare Java are trei tipuri de comentarii:

• Comentarii tradiționale: Primele cinci linii ale listei formează un comentariu tradițional . Comentariul începe cu * și se termină cu * /. Totul între deschiderea / * și închiderea * / este doar pentru ochii oamenilor. Nici o informație despre "Java For Dummies, ediția a 6-a" sau Wiley Publishing, Inc. este tradusă de compilator.

  A doua, a treia, a patra și a cincea linie din listele 3-6 au asteriscuri suplimentare (*). Acestea sunt numite în plus, deoarece aceste asteriscuri nu sunt necesare când creați un comentariu. Ele fac doar comentariul să arate destul.

• Comentariile de la sfârșitul liniei: Textul // I? Tu? în listă este un comentariu la sfârșitul liniei . Un comentariu de la sfarsitul liniei incepe cu doua randuri si merge la sfarsitul unei linii de tip. Încă o dată, compilatorul nu traduce textul în comentariul de la sfârșitul liniei.

• Javadoc comentarii: Comentariul javadoc începe cu un slash și două asteriscuri (/ **). Lista are două comentarii javadoc - una cu textul Clasa Displayer … și alta cu textul Metoda principală este unde ….

  Comentariul unui javadoc este un fel de comentariu tradițional. Un comentariu javadoc este menit să fie citit de oameni care niciodată nu se uită la codul Java. Dar asta nu are sens. Cum puteți vedea comentariile javadoc?

  Ei bine, un anumit program numit javadoc (ce altceva?) Poate găsi toate comentariile javadoc din listă și transformă aceste comentarii într-o pagină web frumoasă. Această figură arată pagina.

  

Comentariile lui Javadoc sunt minunate. Iată câteva lucruri minunate despre ele:

• Singura persoană care trebuie să se uite la o bucată de cod Java este programatorul care scrie codul.Cei care folosesc codul pot afla ce face codul vizualizând pagina Web generată automat.

• Deoarece alte persoane nu se uită la codul Java, alte persoane nu fac schimbări în codul Java. (Cu alte cuvinte, alte persoane nu introduc erori în codul Java existent.)

• Deoarece alții nu se uită la codul Java, alți oameni nu trebuie să descifreze funcționarea interioară a codului Java. Toți acești oameni trebuie să știe despre cod este ceea ce au citit pe pagina web a codului.

• Programatorul nu creează două lucruri separate - unele coduri Java aici și unele documente despre codul de acolo. În schimb, programatorul creează o bucată de cod Java și încorporează documentația (sub forma comentariilor javadoc) chiar în interiorul codului.

• Cel mai bine, generarea de pagini web din comentariile javadoc este automată. Documentația fiecăruia are același format. Indiferent de codul pe care îl utilizați, aflați despre acest cod prin citirea unei pagini ca cea din figură. Asta e bine, deoarece formatul este familiar pentru oricine utilizează Java.