javadoc이란?

Javadoc

Java 소스에 문서화를 하는 방법으로 클래스나 메소드에 주석으로 기술한 내용을 javadoc 명령어나 또는 이를 이용한

빌드 툴(maven의 pharse 등)을 사용하여 문서화할 수 있다. 문서화할 주석을 달 경우

/** 두 개로 시작하고 */ 로 끝나야 한다. 특별한 키워드는 @keyword 형식으로 작성한다.

@author

소스의 저자를 의미하며 이클립스에서는 기본 값으로 윈도우 계정id를 사용한다. 버전 관리 시스템에 변경 이력이 남아있고

한 소스를 여럿이 고치는 경우가 많으므로 회사에서는 사용하지 않는다.

{@link}

내/외부 클래스나 메소드등을 연결할 때 사용하며 다른 키워드(@deprcated 등)와 같이 사용해야 하는 경우 유용

@deprecated

오래되서 더 이상 사용을 권장하지 않는 클래스, 메소드, 인터페이스에 사용하며 @Deprecated에 이노테이션과 같이 사용하면

더욱 유용함

@see

다른 클래스나 메소드를 참고할 경우 사용

@see className

클래스 이름 연결

@see #method - 클래스내 메소드나 변수 연결

• #method : 현재 클래스의 메소드나 변수 연결
• MyClass#method : MyClass 클래스의 메소드나 변수 연결
• my.package.MyClass#method : my.package에 있는 MyClass 클래스의 메소드나 변수 연결

여러 개의 메소드가 오버로딩 되어 있을 경우 파라미터를 같이 기술

 

@since

클래스나 메소드나 언제부터 있었는지 여부를 지정. API로 제공하는 경우 API 사용자가 어는 버전의 라이브러리에서

이 기능을 제공하는지 알아야 의존성을 제대로 설정할 수 있으므로 중요한 키워드임

 

@param

파라미터 이름과 용도 기술