Legger til kommentarer til Java Code - dummies

Denne Java-oppføringen har en forbedret versjon av et prøveprogram. I tillegg til alle søkeordene, identifikatorene og tegnsettingene, har den tekst som er ment for menneskene å lese.

/ * * Oppføring 3-6 i "Java for dummies, 6. utgave" * * Opphavsrett 2014 Wiley Publishing, Inc. * Alle rettigheter reservert. * / / ** * Displayer-klassen viser tekst * på skjermen. * * @author Barry Burd * @version 1. 0 10/24/13 * @see java. Lang. System * / offentlig klasse Displayer {/ ** * Hovedmetoden er hvor * kjøringen utføres. * * @param args (Se kapittel 11.) * / Statisk statisk tomt hoved (String args []) {System. ute. println ("Jeg elsker Java!"); //JEG? Du?}}

A kommentar er en spesiell del av tekst i et program hvis formål er å hjelpe folk å forstå programmet. En kommentar er en del av et godt programs dokumentasjon.

Java-programmeringsspråket har tre typer kommentarer:

• Tradisjonelle kommentarer: De fem første linjene i noteringsskjemaet er en tradisjonell kommentar. Kommentaren begynner med / * og slutter med * /. Alt mellom åpningen / * og avsluttende * / er kun for menneskelige øyne. Ingen informasjon om "Java For Dummies, 6th Edition" eller Wiley Publishing, Inc. oversettes av kompilatoren.

  Den andre, tredje, fjerde og femte linjen i liste 3-6 har ekstra stjerner (*). De kalles ekstra fordi disse stjernene ikke kreves når du lager en kommentar. De gjør bare kommentaren ser pen ut.

• End-of-line kommentarer: Teksten // Jeg? Du? I oppføringen er en enden av linjen kommentar. En end-of-line kommentar starter med to skråstreker og går til enden av en linje av typen. Igjen, kompilatoren oversetter ikke teksten inne i enden av kommentaren.

• Javadoc kommentarer: A javadoc Kommentaren starter med en skråstrek og to stjerner (/ **). Oppføringen har to javadok kommentarer - en med teksten The Displayer-klassen … og en annen med teksten Hovedmetoden er hvor ….

  En javadoc-kommentar er en spesiell type tradisjonell kommentar. En javadoc-kommentar er ment å bli lest av folk som aldri ser på Java-koden. Men det gir ikke mening. Hvordan kan du se javadoc-kommentarene?

  Vel, et bestemt program kalt javadoc (hva mer?) Kan finne alle javadoc-kommentarene i noteringen og gjøre disse kommentarene til en flott webside. Denne figuren viser siden.

  

Javadoc kommentarer er flotte. Her er flere gode ting om dem:

• Den eneste personen som må se på et stykke Java-kode, er programmereren som skriver koden.Andre som bruker koden, kan finne ut hva koden gjør ved å se den automatisk genererte nettsiden.

• Fordi andre ikke ser på Java-koden, gjør andre ikke endringer i Java-koden. (Med andre ord, introduserer andre ikke feil i eksisterende Java-kode.)

• Fordi andre mennesker ikke ser på Java-koden, trenger andre ikke å dechiffrere de indre funksjonene til Java-koden. Alle disse menneskene trenger å vite om koden er hva de leser på kodes nettside.

• Programmeren lager ikke to separate ting - noen Java-kode her og noen dokumentasjon om koden der borte. I stedet oppretter programmøren ett stykke Java-kode og innebærer dokumentasjonen (i form av javadoc kommentarer) rett inne i koden.

• Best av alt, generering av nettsider fra javadoc kommentarer er automatisk. Så alles dokumentasjon har samme format. Uansett hvilken Java-kode du bruker, finner du ut om den koden ved å lese en side som den i figuren. Det er bra fordi formatet er kjent for alle som bruker Java.