@deprecated 태그

편집일시: 2019-10-14 00:57 조회수: 678 댓글수: 0
`@deprecated` 태그는 클래스나 메소드 등을 더 이상 사용이 권장하지 않는 경우에 사용한다. 사용이 권장되지 않는다는 것은 사용을 불가능하다는 것은 아니다. 다만 권장을 하지 않고 차후에 없어질 수도 있다는 것을 의미한다. ``` @deprecated deprecated-text 사용이 권장하지 않는 경우에 지정한다. 작성 위치 : 개요, 패키지, 클래스, 인터페이스, 필드, 메소드 중복 작성 : 불가능 출력 형식 : Deprecated. + 입력한 문자열 ``` 사용을 권장하지 않게 된 이유 등을 문자열로 작성한다. 사용 방법 다음과 같다. ```java /**  * 주석의 설명문  * @deprecated 다른 방법으로 대체되었다.  */ ``` 또한, 대체하는 메소드나 클래스 등의 링크를 따라 지정한다. 링크 지정은 [{@link} 태그](http://www.devkuma.com/books/pages/1248)를 사용한다. ```java /**  * 주석의 설명문  * @deprecated 다른 메소드로 대체되었다 {@link #setScale ()}  */ ``` `@deprecated`에 지정된 문자열은 "Deprecated."라고 문자열과 함께 주석의 설명문 앞에 표시된다. ## 실습 그럼 간단한 예를 실습해 보도록 하겠다. ```java /** * Javadoc 테스트용 클래스 */ public class Sample09 { /** * 사이즈 설정 * * @param width 폭 * @param height 높이 * @see Sample08_02#getWidth() * @see Sample08_02#getHeight() * @deprecated 다른 메소드로 대체되었다 {@link #setScale(int, int)} */ public void setSize(int width, int height) { } /** * 사이즈 설정 * * @param width 폭 * @param height 높이 */ public void setScale(int width, int height){ } } ``` 그럼 위에 소스 코드를 "Sample09.java"라는 파일명으로 저장하고 저장된 디렉토리에서 다음과 같이 실행한다. ``` $ javadoc -d doc Sample09.java ``` 생성된 "doc" 디렉토리에 있는 "Sample09.html" 파일을 브라우저로 확인해 보자. ![javadoc](/data/page/1243/javadoc9.png) 메소드에 "Deprecated."가 먼저 나오고 `@deprecated` 태그로 작성한 내용이 표시되는 것을 볼 수 있다. ![javadoc](/data/page/1243/javadoc9_1.png) `@deprecated` 태그로 작성한 내용은 주석의 설명문보다 앞에 표시되는 점에 주의하자. ※ 요즘에는 비권장 메소드나 클래스 앞에 코드로 `@Deprecated` 어노테이션을 넣는 것을 권장하고 있다.

이전 글 : @see 태그
다음 글 : @since 태그