더 이상 사용되지 않는 클래스를 Java로 주석 처리하는 가장 좋은 방법은 무엇입니까?


11

Java에서 더 이상 사용되지 않는 클래스를 식별하기 위해 주석을 추가하는 가장 좋은 방법을 알고 싶습니다. 다른 프로그래머가 해당 클래스가 무엇인지 알 수 있도록 클래스 상단에 추가 된 이전 주석을 제거해야합니까, 아니면 주석 아래에 추가해야합니까?

답변:


17

Java에서 클래스, 메소드 또는 필드를 더 이상 사용하지 않기 위해 권장되는 방법 @Deprecated은 Java 5에서 제공되는 주석 또는 @deprecatedJava 1.1 이후로 사용 된 JavaDoc 태그를 사용하는 것입니다. 오라클은 관련성이있는 것으로 보이는 API언제 어떻게 폐기 할 것인지에 대한 문서를 보유하고 있습니다.

다른 프로그래머가 해당 클래스가 무엇인지 알거나 주석 아래에 추가하는 데 도움이되는 클래스 상단에 추가 된 이전 주석을 제거해야합니까?

JavaDoc 태그 또는 주석을 추가하는 것 외에 기존 주석을 편집하거나 제거해서는 안됩니다. 더 이상 사용되지 않는 코드는 여전히 레거시 시스템에서 사용 중일 수 있으며 해당 시스템의 개발자는 원래 개발자가 어떤 형식으로 수행 한 설명서에 액세스해야합니다.


1
+1 : @Depricated 어노테이션을 사용하면 Eclipse와 같은 IDE를 사용하여 해당 메소드를 교차시키고 개발자에게 시각적 힌트를 제공 할 수 있습니다.
Ryan Hayes

예, 더 이상 사용되지 않는 방법을 알고 사용하지 않는 주석 내 질문은 예를 들어이 코드가 있습니다 ** ** 클래스에 대한 주석 ** / public class ClassToDeprecate {// 여기에 코드가 있습니다}
alculete

1
@Spammer 내가 링크 한 기사가 그 내용을 설명합니다. 또한 Java API 설명서를 탐색하면 이에 대한 답변을 얻을 수 있습니다. @Deprecated주석 또는 @deprecatedJavaDoc 태그를 추가해야합니다 . 그게 다야-다른 것도없고 더 이상 없다.
토마스 오웬스


1
주석 @deprecated과 함께 JavaDoc 태그와 설명을 추가하면 @Deprecated더 이상 사용되지 않는 이유를 더 많이 알 수 있습니다. 따라서 @Deprecated주석 보다는 두 가지를 모두 사용하는 것이 더 유리합니다 .
WarFox
당사 사이트를 사용함과 동시에 당사의 쿠키 정책개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.