Lägg till kommentarer till Java-kod - dummies

Denna Java-lista har en förbättrad version av ett programprogram. Förutom alla nyckelord, identifierare och skiljetecken har den text som är avsedd för människor att läsa.

/ * * Lista 3-6 i "Java For Dummies, 6: e upplagan" * * Copyright 2014 Wiley Publishing, Inc. * Alla rättigheter förbehållna. * / / ** * Displayer-klassen visar text * på datorskärmen. * * @author Barry Burd * @version 1. 0 10/24/13 * @see java. lang. System * / Public Class Displayer {/ ** * Den huvudsakliga metoden är var * körning av koden börjar. * * @param args (Se kapitel 11.) * / statisk statisk tomt huvud (String args []) {System. ut. println ("Jag älskar Java!"); //JAG? Du?}}

A kommentar är en speciell textdel i ett program vars syfte är att hjälpa människor att förstå programmet. En kommentar är en del av ett bra program dokumentation.

Java-programmeringsspråket har tre typer av kommentarer:

• Traditionella kommentarer: De fem första raderna i noteringsformuläret är en traditionell kommentar. Kommentaren börjar med / * och slutar med * /. Allt mellan öppningen / * och slutet * / är endast för mänskliga ögon. Ingen information om "Java For Dummies, 6th Edition" eller Wiley Publishing, Inc. översätts av kompilatorn.

  Den andra, tredje, fjärde och femte raden i lista 3-6 har extra asterisker (*). De kallas extra eftersom dessa asterisker inte krävs när du skapar en kommentar. De gör bara kommentaren ser fin ut.

• End-of-line kommentarer: Texten // I? Du? i listan är en slutet av rad kommentar. En slutgiltig kommentar börjar med två snedstreck och går till slutet av en linje av typen. Återigen översätter kompilatorn inte texten i slutet av kommentaren.

• Javadoc kommentarer: A javadoc kommentar börjar med ett snedstreck och två asterisker (/ **). Listan har två javadoc kommentarer - en med texten The Displayer-klassen … och en annan med texten Den huvudsakliga metoden är var ….

  En javadoc kommentar är en speciell typ av traditionell kommentar. En javadoc-kommentar är avsedd att läsas av personer som aldrig ens tittar på Java-koden. Men det är inte meningsfullt. Hur kan du se javadoc-kommentarerna?

  Tja, ett visst program som heter javadoc (vad mer?) Kan hitta alla javadoc kommentarer i listan och göra dessa kommentarer till en snygg webbsida. Den här siffran visar sidan.

  

Javadoc kommentarer är stora. Här är flera stora saker om dem:

• Den enda personen som måste titta på en bit av Java-kod är programmeraren som skriver koden.Andra som använder koden kan ta reda på vad koden gör genom att visa den automatiskt genererade webbsidan.

• Eftersom andra inte tittar på Java-koden, gör andra inte ändringar i Java-koden. (Med andra ord introducerar inte andra personer fel i den befintliga Java-koden.)

• Eftersom andra inte tittar på Java-koden, behöver andra inte dechifiera Java-kodens inre funktioner. Alla dessa människor behöver veta om koden är vad de läser på kodens webbsida.

• Programmeraren skapar inte två separata saker - en del Java-kod här och en del dokumentation om koden där borta. I stället skapar programmeraren en bit av Java-kod och inbjuder dokumentationen (i form av javadoc kommentarer) precis inuti koden.

• Bäst av allt är generationen av webbsidor från javadoc kommentarer automatiskt. Så allas dokumentation har samma format. Oavsett vilken Java-kod du använder får du reda på den koden genom att läsa en sida som den i figuren. Det är bra eftersom formatet är bekant för alla som använder Java.