Video: Code Format in Word 2024
Denne Java-fortegnelse har en forbedret version af et prøveprogram. Ud over alle nøgleord, identifikatorer og tegnsætning har det tekst, der er meningen for mennesker at læse.
/ * * Listing 3-6 i "Java For Dummies, 6th Edition" * * Copyright 2014 Wiley Publishing, Inc. * Alle rettigheder forbeholdes. * / / ** * Displayer-klassen viser tekst * på computerskærmen. * * @author Barry Burd * @version 1. 0 10/24/13 * @see java. Lang. System * / Public Class Displayer {/ ** * Den vigtigste metode er, hvor * koden udføres. * * @param args (Se kapitel 11.) * / offentlig statisk tomgang hoved (String args []) {System. ud. println ("Jeg elsker Java!"); //JEG? Du?}}
A kommentar er et særligt afsnit af tekst inde i et program, hvis formål er at hjælpe folk med at forstå programmet. En kommentar er en del af et godt programs dokumentation.
Java-programmeringssproget har tre slags kommentarer:
-
Traditionelle kommentarer: De første fem linjer i noteringsblanketten er en traditionel kommentar. Kommentaren begynder med / * og slutter med * /. Alt mellem åbningen / * og afslutningen * / er kun til menneskelige øjne. Ingen oplysninger om "Java For Dummies, 6th Edition" eller Wiley Publishing, Inc. oversættes af kompilatoren.
Den anden, tredje, fjerde og femte linje i liste 3-6 har ekstra stjerner (*). De kaldes ekstra, fordi disse stjerner ikke er nødvendige, når du opretter en kommentar. De gør bare kommentaren ser smuk ud.
-
End-of-line kommentarer: Teksten // I? Du? i noteringen er en ende-of-line kommentar. En end-of-line kommentar starter med to skråstreger og går til enden af en linje af typen. Endnu en gang oversætter kompilatoren ikke teksten inde i end-of-line-kommentaren.
-
Javadoc kommentarer: A javadoc kommentar begynder med et skråstreg og to stjerner (/ **). Noteringen har to javadoc kommentarer - en med teksten The Displayer klasse … og en anden med teksten Den vigtigste metode er hvor ….
En javadoc-kommentar er en særlig slags traditionel kommentar. En javadoc-kommentar er beregnet til at blive læst af folk, der aldrig engang ser på Java-koden. Men det giver ikke mening. Hvordan kan du se javadoc-kommentarerne?
Nå, et bestemt program kaldet javadoc (hvad mere?) Kan finde alle javadoc-kommentarerne i noteringen og gøre disse kommentarer til en flot webside. Dette tal viser siden.
Javadoc kommentarer er gode. Her er flere gode ting om dem:
-
Den eneste, der skal se på et stykke Java-kode, er programmereren, der skriver koden.Andre personer, der bruger koden, kan finde ud af, hvad koden gør ved at se den automatisk genererede webside.
-
Da andre ikke ser på Java-koden, ændrer andre mennesker ikke Java-koden. (Med andre ord introducerer andre ikke fejl i den eksisterende Java-kode.)
-
Da andre ikke ser på Java-koden, behøver andre mennesker ikke at dechiffrere de indvendige funktioner i Java-koden. Alle disse mennesker har brug for at vide om koden er, hvad de læser på kodens webside.
-
Programmeren opretter ikke to separate ting - nogle Java-kode her og nogle dokumentation om koden derovre. I stedet skaber programmøren et stykke Java-kode og indgår dokumentationen (i form af javadoc-kommentarer) lige inde i koden.
-
Bedst af alt er generationen af websider fra javadoc kommentarer automatisk. Så alles dokumentation har samme format. Uanset hvilken Java-kode du bruger, finder du ud af den kode ved at læse en side som den i figuren. Det er godt, fordi formatet er kendt for alle, der bruger Java.
