I Java er kommentarer ikke-kjørbare uttalelser som forklarer kode og forbedrer lesbarheten. De ignoreres av kompilatoren og påvirker ikke programkjøringen.
- Forbedre kodelesbarhet og vedlikeholdsvennlighet.
- Nyttig for feilsøking og dokumentering av logikk.
Java støtter tre hovedtyper kommentarer:
1. Enkeltlinjekommentarer
Enkeltlinjekommentarer brukes til å kommentere én kodelinje.
Syntaks:
Java// Kommentarer her (Kun tekst i denne linjen anses som kommentar)
// Java program to show single line comments class GFG { public static void main(String args[]) { // Single line comment here System.out.println('Single Line Comment Above'); } }
Produksjon
Single Line Comment Above
2. Kommentarer med flere linjer
Flerlinjekommentarer brukes til å beskrive kompleks kode eller metoder, da det kan være kjedelig å skrive flere enkeltlinjers kommentarer.
Java/*
Kommentaren starter
fortsetter
fortsetter...
Kommentaren avsluttes
*/
class GFG { public static void main(String args[]) { System.out.println('Multi Line Comments Below'); /* Comment line 1 Comment line 2 Comment line 3 */ } }
Produksjon
Multi Line Comments Below
3. Dokumentasjonskommentarer
Dokumentasjonskommentarer brukes til å generere ekstern dokumentasjon ved hjelp av Javadoc. De brukes vanligvis i profesjonelle prosjekter for å beskrive klassers metoder og parametere.
Syntaks:
Java/**
* Kommentar start
* @param param-navn beskrivelse
* @returbeskrivelse
*/
/** * * Calculates the average of three integers. * @author Pratik Agarwal * @version 1.0 * @since 2017-02-18 */ public class FindAvg{ /** * Finds average of three integers. * @param numA First parameter * @param numB Second parameter * @param numC Third parameter * @return Average of numA numB and numC */ public int findAvg(int numA int numB int numC) { return (numA + numB + numC) / 3; } /** * Main method which uses findAvg method * @param args Unused */ public static void main(String args[]){ FindAvg obj = new FindAvg(); int avg = obj.findAvg(10 20 30); System.out.println('Average of 10 20 and 30 is: ' + avg); } }
Produksjon
Average of 10 20 and 30 is: 20
Relatert artikkel: JavaDoc-verktøy
java-listen er tom