>  기사  >  Java  >  자바 주석

자바 주석

WBOY
WBOY원래의
2024-08-30 16:06:26473검색

주석은 JDK(Java Development Kit) 1.5 버전에 도입되었거나 제공되었습니다. Java의 주석은 코드 구조에 있는 데이터에 대한 추가 정보를 제공합니다. 즉, 이는 메타데이터라고도 알려진 데이터에 대한 데이터입니다.

Java의 주석이란 무엇인가요?

주석은 코드에서 표준화된 방식으로 메타데이터를 정의하는 데 도움이 됩니다. 또한 주석은 Java 코드를 컴파일하는 동안 따라야 할 지침을 Java 컴파일러에 제공하는 데 도움이 됩니다.

무료 소프트웨어 개발 과정 시작

웹 개발, 프로그래밍 언어, 소프트웨어 테스팅 등

자바 주석

주석을 사용할 때 '@' 기호를 사용하고 그 뒤에 주석 이름을 붙여 컴파일러가 주석으로 처리하도록 합니다.

주석은 미리 추가할 수 있다는 점에 유의하는 것이 중요합니다.

  • 수업 선언
  • 멤버 변수 선언
  • 생성자 선언
  • 메서드 선언
  • 매개변수 선언
  • 지역변수 선언.

기억해야 할 중요한 점은 모든 주석이 java.lang.annotation.Annotation 인터페이스를 확장한다는 것입니다. 또한 주석에는 확장 조항을 포함할 수 없습니다.

내장 Java 주석

Java에는 특정 목적을 위해 설계되고 위의 상황 중 하나에서 사용되는 @Override, @Deprecated, @SuppressWarnings와 같은 내장 주석이 있습니다. 방법 등

예 #1 – 재정의

코드:

class Dad {
public void say() {
System.out.println("Do your homework");
}
}
public class Child extends Dad {
@Override
public void say(){
System.out.println("I wanna play");
}
public static void main(String args[]){
Dad daddy = new Child();
daddy.say();
}
}

출력:

자바 주석

예 #2 – 더 이상 사용되지 않음

코드:

public class Outdated
{
@Deprecated
public void oldShow()
{
System.out.println("This Method is deprecated");  }
public static void main(String args[])
{
Outdated  od = new Outdated ();
od.oldShow();
}
}

출력:

자바 주석

자바 주석

메타 주석

메타 주석에는 다섯 가지 유형이 있습니다.

  1. 문서화 – 이 주석을 사용하는 멤버, 변수 또는 클래스를 Javadoc 또는 사용 가능한 기타 유사한 도구로 문서화해야 함을 알립니다.
  2. 대상 – 주석이 사용되는 유형을 지정하는 데 사용됩니다. 주로 사용자 정의 주석과 함께 사용됩니다.
  3. 상속 – 주석이 하위 클래스에 상속되도록 표시합니다.
  4. 보존 – 주석이 달린 유형의 주석을 얼마나 오랫동안 보관할지 나타냅니다. 가능한 값은 SOURCE, CLASS 및 RUNTIME인 보존 정책 인수를 사용합니다.
  5. 반복 가능 - 주석을 추가한 선언이 있는 주석 유형이 반복 가능함을 알립니다.

예 – 문서화 및 보관

코드:

import java.lang.annotation.*;
@Retention(RetentionPolicy.RUNTIME)
@interface RSample {
String rentent();
}
@Documented
@interface DSample {
String doc();
}
public class MetaAnnotate {
public static void main(String arg[])
{
new MetaAnnotate().rentent();
new MetaAnnotate().doc();
}
@RSample (rentent="Meta Info R")
public void rentent() {
System.out.println("Retention Policy Applied");
}
@DSample(doc="Meta Info D")
public void doc() {
System.out.println("Code Documented with the value");
}
}

출력:

자바 주석

설명:

  • RetentionPolicy.RUNTIME – 이 값은 Java 리플렉션을 통해 검사를 위해 런타임에 주석 값을 사용할 수 있도록 지정합니다.
  • Javadoc 명령을 실행하여 코드 문서를 확인하세요.

주석 유형

주석에는 세 가지 카테고리가 있으며 그 내용은 다음과 같습니다.

1. 마커 주석 – 이러한 유형의 주석은 개발자에게 아래 함수 또는 클래스가 무엇인지 알리기 위한 선언으로 사용됩니다. 즉, 함수가 다른 함수를 재정의하는지 여부와 같은 함수 또는 클래스에 대한 추가 정보를 공유합니다. deprecated 함수 등 @Override, @Deprecated는 마커 주석으로 간주됩니다.

예: DemoAnnotation()

2. 단일 값 주석 – 이런 종류의 주석은 주석이 앞에 배치되는 해당 구성원의 값을 지정하기 위해 값을 취하므로 해당 구성원의 이름을 지정할 필요가 없습니다.

예: DemoAnnotation(“custId123”)

3. 전체 주석 – 이 종류의 주석은 여러 값, 쌍, 멤버를 사용합니다.

예: DemoAnnotation(category=”장난감”, 값=1500)

커스텀

맞춤 주석은 아래 예에서 볼 수 있듯이 사용자 인터페이스에 의해 생성되며 그 뒤에 주석 이름이 붙습니다.

파일 1: 정의된 사용자 정의 주석

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface Magicians
{
String Wizard() default "Reynolds";
String House() default "Green";
}
@Magicians
public class Magician
{
@Magicians(Wizard = "Harry Potter", House = "Red")
public String getString()  {  return null; }
}

파일 2: Custom Annotation Class를 호출하는 메인 클래스

import java.lang.annotation.Annotation;
import java.lang.reflect.AnnotatedElement;
import java.lang.reflect.Method;
public class MyCustomAnnotation
{
public static void main(String[] args) throws NoSuchMethodException, SecurityException
{
new Magician();
Class<Magician> magic = Magician.class;
readAnnotationOn(magic);
Method method = magic.getMethod("getString", new Class[]{});
readAnnotationOn(method);
}
static void readAnnotationOn(AnnotatedElement element)
{
try
{
System.out.println("\n Find annotations on " + element.getClass().getName());
Annotation[] annotations = element.getAnnotations();
for (Annotation annotation : annotations)
{
if (annotation instanceof Magicians)
{
Magicians mData = (Magicians) annotation;
System.out.println("Wizard Name :" + mData.Wizard());
System.out.println("Wizard House Color :" + mData.House());
}
}
} catch (Exception e)
{
e.printStackTrace();
}
}
}

출력:

자바 주석

결론

이 글에서는 Java 주석이 무엇인지, 그 유형에 대해 예시와 함께 알아보았습니다. Java에서 제공하는 내장 주석의 예를 살펴보고 맞춤 주석을 코딩했습니다. 코드를 표준화하고 코드와 그 구조를 더 잘 이해하는 데 도움이 되는 주석을 보았습니다.

위 내용은 자바 주석의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!

성명:
본 글의 내용은 네티즌들의 자발적인 기여로 작성되었으며, 저작권은 원저작자에게 있습니다. 본 사이트는 이에 상응하는 법적 책임을 지지 않습니다. 표절이나 침해가 의심되는 콘텐츠를 발견한 경우 admin@php.cn으로 문의하세요.