빽기의 코딩공부Story

javadoc 주석 사용법 본문

기타

javadoc 주석 사용법

빽기 2025. 3. 12. 12:42
@author 클래스 또는 메서드를 작성한 사람 @author John Doe
@version 클래스나 메서드의 버전 정보 @version 1.0.0
@since 특정 버전부터 사용 가능함을 나타냄 @since 1.5
@param 메서드의 매개변수를 설명 @param name 사용자 이름
@return 메서드가 반환하는 값을 설명 @return 사용자의 전체 이름
@throws 또는 @exception 예외를 던질 경우 설명 @throws IOException 파일을 찾을 수 없음
@deprecated 더 이상 사용되지 않는 메서드나 클래스 @deprecated 대신 newMethod()를 사용하세요.
@see 관련된 클래스나 메서드를 참조 @see java.util.List
@link 다른 클래스나 메서드에 하이퍼링크 생성 {@link #methodName()}
@code 코드 블록을 인라인으로 표시 Example: {@code int x = 10;}
@literal 태그를 문자열로 표시 (HTML 코드 해석 방지) {@literal <b>bold</b>}
@serial 직렬화 가능한 필드를 설명 @serial 직렬화 ID
@serialField ObjectStreamField 필드 설명 @serialField fieldName int 설명
@serialData writeObject()에서 추가된 직렬화 데이터 설명 @serialData 직렬화된 데이터 설명
@see 관련된 참조 추가 @see String
@category JDK 9 이상에서 사용, 모듈이나 패키지 분류 @category Utility
@summary Java 18부터 사용, 요약 설명 추가 @summary 이 메서드는 사용자 정보를 반환합니다.
Comments