Video: Introduction to Programs Data Types and Variables 2024
Deze Java-vermelding heeft een verbeterde versie van een voorbeeldprogramma. Naast alle zoekwoorden, ID's en interpunctie heeft deze tekst die bedoeld is voor mensen om te lezen.
/ * * Listing 3-6 in "Java voor Dummies, 6de editie" * * Copyright 2014 Wiley Publishing, Inc. * Alle rechten voorbehouden. * / / ** * De klasse Displayer geeft tekst * weer op het computerscherm. * * @author Barry Burd * @version 1. 0 10/24/13 * @see java. Lang. System * / public class Displayer {/ ** * De belangrijkste methode is waar * de uitvoering van de code begint. * * @param args (zie hoofdstuk 11.) * / public static void main (String args []) {System. uit. println ("I love Java!"); //IK? U?}}
A comment is een speciaal tekstgedeelte binnen een programma waarvan het doel is om mensen te helpen het programma te begrijpen. Een opmerking maakt deel uit van de documentatie van een goed programma.
De Java-programmeertaal heeft drie soorten opmerkingen:
-
Traditionele opmerkingen: De eerste vijf regels van de lijst vormen één traditionele opmerking. De opmerking begint met / * en eindigt met * /. Alles tussen de opening / * en de sluiting * / is alleen voor menselijke ogen. Geen informatie over "Java For Dummies, 6th Edition" of Wiley Publishing, Inc. wordt vertaald door de compiler.
De tweede, derde, vierde en vijfde regel in listing 3-6 hebben extra sterretjes (*). Ze worden extra genoemd omdat deze sterretjes niet vereist zijn wanneer u een opmerking maakt. Ze maken de opmerking er gewoon mooi uit.
-
Opmerkingen einde regel: De tekst // I? U? in de aanbieding staat een end-of-line opmerking. Een opmerking aan het einde van een regel begint met twee schuine strepen en gaat naar het einde van een regel tekst. Nogmaals, de compiler vertaalt de tekst niet binnen het einde van de regelcommentaar.
-
Javadoc-opmerkingen: Een javadoc -commentaar begint met een schuine streep en twee sterretjes (/ **). De lijst heeft twee javadoc-opmerkingen - een met de tekst De klasse Displayer … en een andere met de tekst De belangrijkste methode is waar ….
Een javadoc-opmerking is een speciaal soort traditionele opmerking. Een javadoc-opmerking is bedoeld voor mensen die nooit naar de Java-code kijken. Maar dat klopt niet. Hoe kun je de javadoc-opmerkingen zien?
Welnu, een bepaald programma met de naam javadoc (wat anders?) Kan alle javadoc-opmerkingen in de lijst vinden en deze opmerkingen omzetten in een mooie webpagina. Deze afbeelding toont de pagina.
Javadoc reacties zijn geweldig. Hier zijn enkele geweldige dingen over:
-
De enige persoon die naar een stukje Java-code moet kijken, is de programmeur die de code schrijft.Andere mensen die de code gebruiken, kunnen achterhalen wat de code doet door de automatisch gegenereerde webpagina te bekijken.
-
Omdat andere mensen niet naar de Java-code kijken, maken andere mensen geen wijzigingen in de Java-code. (Met andere woorden, andere mensen introduceren geen fouten in de bestaande Java-code.)
-
Omdat andere mensen niet naar de Java-code kijken, hoeven andere mensen de interne werking van de Java-code niet te ontcijferen. Al deze mensen moeten weten over de code is wat ze lezen op de webpagina van de code.
-
De programmeur maakt geen twee afzonderlijke dingen - wat Java-code hier en wat documentatie over de code daar. In plaats daarvan maakt de programmeur één stuk Java-code en neemt de documentatie (in de vorm van javadoc-opmerkingen) op in de code.
-
Het allerbelangrijkste is dat het genereren van webpagina's van javadoc-opmerkingen automatisch gebeurt. Dus de documentatie van iedereen heeft hetzelfde formaat. Ongeacht de Java-code die je gebruikt, je ontdekt die code door een pagina te lezen zoals die in de figuur. Dat is goed, want het formaat is bekend bij iedereen die Java gebruikt.
