@Param

자바 JAVA

[Java] javadoc이란 | 전제조건 & 사후조건 @param, @return @throw

javadoc 이란? javadoc은 자바 개발자들이 자바 소스 코드를 문서화하기 위해 사용하는 도구입니다. javadoc은 소스 코드에 있는 특정 주석을 기반으로 문서를 생성합니다. 이러한 문서에는 소스 코드에 대한 명세서(specification), 클래스(class)와 메서드(method)의 사용 방법, 인수(parameter)와 반환 값(return)의 의미 등의 정보가 포함됩니다. 왜 작성해야하죠? javadoc을 사용하면 다른 개발자들이 소스 코드를 이해하고 사용하는 데 도움이 되는 자세한 문서를 제공할 수 있습니다. 또한 javadoc을 사용하면 코드에 변경이 있을 때 문서를 업데이트하거나 새로 생성할 수 있으므로 소스 코드와 일관성 있는 문서를 유지할 수 있습니다. 꼭 개발에 관련된 부분이..

Jelong
'@Param' 태그의 글 목록