JAVA에서 주석 처리 3가지 방법

• //
• /* */
• /** */ (문서화주석)

문서화 주석

문서화 주석은 /** 로 시작해서 */ 로 끝나는데 이 문서화 주석을 사용하면 javadoc 이라는 유틸을 사용하여 HTML문서로 저장이 가능하다

즉 프로그램의 문서화를 편하게 할 수 있다

javadoc에서 인식하는 태그는 아래와 같다

Tag	Desc
@author	작성자
@deprecated	클래스나 멤버가 사장되었는지 지정
{@docRoot}	현문서의 루트 디렉토리 경로 지정
@exception	메소드에서의 예외 확인
{@inheritDoc}	사위 클래스로부터 주석을 상속
{@link}	다른 주제에 관한 인랑니 링크 삽입
{@linkplain}	다른 주제에 관한 인라인 링크 삽입: 링크가 평문 텍스트로 표시
@param	메소드의 매개변수 문서화
@return	메소드의 반환 값 문서화
@see	다른 주제에 관한 링크 지정
@serial	기본 직렬화 필드 문서화
@serialData	writeObject()나 writeExteral() 메소드로 기록한 데이터 문서화
@serialField	ObjectStreamField 컴포넌트 문서화
@since	특별한 변경사항이 소개될때 릴리즈 기록
@throws	메소드에서의 예외 확인
{@value}	static 필드여야 하는 상수값 표시
@version	클래스의 버전