Hvordan skrive Java kommentarer?

Java annotations

I denne artikkelen vil vi diskutere om merknader og hvordan de kan brukes i praktisk programmering. First, vi vil diskutere noen konseptuelle ideer og deretter hoppe i koding for å skrive et eksempel program ved hjelp av merknader.

Motivasjon:

I Java-programmering, det finnes flere metoder for å erklære oppførselen til ulike elementer (som metoder, classes, medlemmer etc). I de fleste tilfeller er disse erklæringene er definert i noen eksterne filer (XML, egenskapsfilen etc). Og så disse filene er referert i programmet for å få det utført.

Ved annotering, tilnærmingen er helt annerledes. Stempler er meta-data og de som er skrevet i et bestemt format. Disse merknads elementene er skrevet i Java-programmet i seg selv. So, det er ikke nødvendig å referere noen eksterne filer, noe som er en stor fordel. These annotations are easy to use and flexible enough to implement.

In the next section we will see how these can be implemented.








What is Java annotation?

A Java annotation is a metadata of a Java program. Or, simply speaking, a Java annotation provides information about a Java program. In most cases, it does not directly influence the program or code.

Why Java annotations are used?

A Java annotation can be used for the following purposes:

  • Providing instructions to the compiler

When the compiler converts the code into machine-readable instructions, annotations can provide the compiler such instructions. Usually, after compilation, the annotations are not present in the code.

  • Providing instructions to the builder

These days, you would let tools like Apache Maven or Apache Ant to build the code. Merknader kan være nyttig for å bygge verktøy. Når bygge verktøy går om sine oppgaver som inkluderer genererer kildekoden, generere XML-filer (e.g. distribusjonen beskrivelser), emballasje koder og filer til en JAR-fil, det ser ut til merknadene til inngangene på å generere kildekode eller filer.

  • Gir instruksjoner til programvaren runtime

Det er mulig å definere merknader for å gi innspill til programvare runtime selv om slike kommentarer kan nås med Java Refleksjoner, et annet verktøy.

Merknader kan være både forhåndsdefinerte og egendefinerte. Mens tilpassede kommentarer kan være av mange typer, forhåndsdefinerte merknader er av følgende tre typer.








@Deprecated merknad indikerer at en klasse, metode eller felt som ikke lenger er i bruk.

@ Override merknad indikerer at en klasse i en metode ikke passer til noen metode i en superklasse. I tilfelle av en mismatch, kompilatoren kaster en feil.

@SuppressWarnings merknad undertrykker advarsler kastet av kompilatoren. For example, hvis en metode kaller en avskrevet metode, kompilatoren kaster en advarsel. Merknaden undertrykker slike advarsler og flere.

Opprette vårt første prosjekt:

I denne delen vil vi opprette et prosjekt ved hjelp av Eclipse IDE. Koden prøven vil vise hvordan merknad fungerer i et reelt miljø. Før du flytter inn i hands-on koding vi trenger for å fullføre installasjons skritt for å gjøre miljøet klar.

Følgende er de installasjonsdetaljer.

Step 1: Sette opp Java Development Kit

nedlasting JDK fra Oracle nettstedet, installere og konfigurere den. Deretter setter miljø PATH og JAVA_HOME variabler.

Step 2: Sette opp Eclipse IDE

Last ned Eclipse fra offesiell nettside. Installer det og sette PATH variabelen.

Step 3: Last ned kommentar pakker fra vår biblioteker.

I vårt eksempel skal vi bruke våren merknads pakker. nedlasting org.springframework.context.jar fra linken over og legg den i lib mappen i Eclipse IDE som vist nedenfor.

Spring packages

Spring pakker

Figur 1: Merknads Krukker i lib-mappen

Nå miljøet er klar til å skrive Java-programmer med merknader.

La oss skape ut første prosjekt ved hjelp av Eclipse IDE.

Opprett et prosjekt i Eclipse og satt pakken navn som com.techalpine.annotation. Under denne pakken opprette tre Java-klasser som vist nedenfor.

Project Structure

Prosjektstruktur struktur~~POS=HEADCOMP

Figure2: prosjektstruktur

Tre klasser er BeanAnnotation.java, BeanAnnotationConfig.java og BeanAnnotationMain.java

Listing1: Dette er bean klassen med getter og setter-metoder

[kode]

pakke com.techalpine.annotation;

public class BeanAnnotation {

private String messagetxt;

public void setMessagetxt(string messagetxt){

this.messagetxt = messagetxt;

}

public void getMessagetxt(){

System.out.println(“Dette er meldingen : ” + messagetxt);

}

}

[/kode]

Neste er konfigurasjonen klasse med @Configuration og @Bønne merknader. Disse kommentarene vil identifisere bønne og informere beholderen for binding.

Listing2: Dette er konfigurasjonen klasse

[kode]

pakke com.techalpine.annotation;

importere org.springframework.context.annotation. *;

@Configuration

public class BeanAnnotationConfig {

@Bønne

offentlig BeanAnnotation beanannotate(){

returnere ny BeanAnnotation();

}

}

[/kode]







Neste er den viktigste klassen å teste merknader og hvordan det fungerer.

Listing3: Dette er den viktigste klassen

[kode]

pakke com.techalpine.annotation;

import org.springframework.context.ApplicationContext;

importere org.springframework.context.annotation. *;

public class BeanAnnotationMain {

public static void main(String[] args) {

ApplicationContext ctx =

ny AnnotationConfigApplicationContext(BeanAnnotationConfig.class);

BeanAnnotation beanannotate = ctx.getBean(BeanAnnotation.class);

beanannotate.setMessagetxt(“Hello, Stempler fungerer fint!”);

beanannotate.getMessagetxt();

}

}

[/kode]








Gjennomføring av prosjektet:

Prosjektstrukturen er ferdig og det er klart til å utføre. Nå kjører programmet som vist nedenfor. Det vil være en frittstående Java-program, så det må kjøres som en Java-applikasjon som vist nedenfor.

Run application

Kjør program

Figur 3: Kjør programmet

Når hovedprogrammet kjøres, det vil vise følgende resultat.

Output

Output

Figure4: Viser utdata på konsollen

Konklusjon:

I denne artikkelen har vi diskutert begrepene merknader og hvordan det kan gjennomføres. Håper det vil hjelpe brukerne til å skrive Java-programmer med merknader.

 

Tagged on: ,
============================================= ============================================== Buy best TechAlpine Books on Amazon
============================================== ---------------------------------------------------------------- electrician ct chestnutelectric
error

Enjoy this blog? Please spread the word :)

Follow by Email
LinkedIn
LinkedIn
Share