Java doc 주석

Java doc 주석?

라이브러리의 주석들을 보면

/**
* @author
* @param
*/

이런식으로 어노테이션(?)같은 주석들을 볼 수 있다.
알고보니 Java doc을 위한 주석이라고 한다.

Java doc이란?

위키백과에 정의된 내용을 따르면

Javadoc은 Java 소스 코드에서 HTML 형식의 API 문서를 생성하기 위해 Java 언어를 위해
Sun Microsystems에서 작성한 문서 생성기입니다.
HTML 형식은 관련 문서를 함께 하이퍼 링크 할 수있는 편의성을 추가하는 데 사용됩니다.

영문 위키백과를 직역으로 가져와서 뭔가 이상하지만
대충 요약해보자면
Java 소스 코드를 HTML 형식의 API 문서로 생성해주는 문서 생성기? 라고 하는 것 같다.
그래서 위의 캡쳐를 보면 HTML 태그도 혼용해서 쓰이는 형식도 보인다.

종류

여러가지 종류가 있는데 간략히 정리해보면 아래와 같다.

@author name

• 제작자 표시

@version 1.0

• 버전 표시

@param variable

• 매개변수에 대한 설명

@return

• return되는 값에 대한 설명

@exception/@throws

• 발생시킬 수 있는 예외 기술

@deprecated

• 다음 버전에서 폐기됨을 알림
  제일 보기 싫은 주석

@serial

• 직렬화 가능한 클래스의 멤버 설명

@see

• 관련 항목으로 외부 링크나 텍스트를 표시 (또는 클래스나 메소드 등)

@since

• 추가(생성)된 날짜 명시

@link

• 메소드나 필드의 상호 참조에 대한 링크 표시

보다 자세한 설명은 나중에 업데이트 해보도록 하겠다.

개인적으로 공부했던 것을 바탕으로 작성하다보니
잘못된 정보가 있을수도 있습니다.
인지하게 되면 추후 수정하겠습니다.
피드백은 언제나 환영합니다.
읽어주셔서 감사합니다.