슬기로운 개발자 생활

@param 태그@param태그는 매개 변수에 대한 설명을 표시 할 때 사용한다.@param parameter-name description 매개 변수에 대한 설명을 표시한다. 작성 위치 : 메소드 중복 작성 : 가능 츌력 형식 : 매개 변수명 및 설명 @author 태그가 중복으로 작성된 경우는 출력 될 때 각각의 저자가 쉼표(,)로 구분하여 한 줄에 모와서 출력된다.메소드의 매개 변수명과 매개 변수에 대한 설명을 작성한다. 사용 방법는 다음과 같다./** * 주석의 설명문 * @param width 폭 * @param height 높이 */ 설명 부분은 여러 줄에 걸쳐 작성 할 수 있다. 여러 줄에 걸쳐있는 것을 표현하는 방법은 특별한 작성법이 있는 것은 아니다./** * 댓글의 설명 * @param..

@since 태그@since 태그 도입된 버전을 표시하는 경우에 사용한다. @version 태그는 현재의 버전을 나타내는 반면 @since 태그는 어떤 버전에서 도입 되었는지 나타내는 점이 다르다.@since since-text 도입 된 버전을 표시한다. 작성 위치 : 개요, 패키지, 클래스, 인터페이스, 필드, 메소드 중복 작성 : 가능 출력 형식 : 도입 된 버전 버전 등을 나타내는 문자열을 지정한다. 사용법은 다음과 같다./** * 주석의 설명문 * @since 2.5.1 */ @since 태그가 중복으로 작성된 경우는 출력 될 때 각각의 버전은 쉼표(,)로 구분하여 한 줄에 모와서 출력된다.실습그럼 간단한 예를 실습해 보도록 하겠다./** * Javadoc 테스트용 클래스 * * @since 2...

@deprecated 태그@deprecated 태그는 클래스나 메소드 등을 더 이상 사용이 권장하지 않는 경우에 사용한다. 사용이 권장되지 않는다는 것은 사용을 불가능하다는 것은 아니다. 다만 권장을 하지 않고 차후에 없어질 수도 있다는 것을 의미한다.@deprecated deprecated-text 사용이 권장하지 않는 경우에 지정한다. 작성 위치 : 개요, 패키지, 클래스, 인터페이스, 필드, 메소드 중복 작성 : 불가능 출력 형식 : Deprecated. + 입력한 문자열 사용을 권장하지 않게 된 이유 등을 문자열로 작성한다. 사용 방법 다음과 같다./** * 주석의 설명문 * @deprecated 다른 방법으로 대체되었다. */ 또한, 대체하는 메소드나 클래스 등의 링크를 따라 지정한다. 링크 지..

@see 태그@see태그는 관련 항목으로 외부 링크 또는 텍스트를 표시하거나, 다른 필드나 메소드에 대한 모든 참조 링크를 나타내는 경우에 사용한다.@see reference 관련 항목으로 텍스트와 링크를 표시 작성 위치 : 개요, 패키지, 클래스, 인터페이스, 필드, 메소드 중복 작성 : 가능 출력 형식 : 관련 항목 텍스트, 외부 링크@see 태그는 텍스트 및 외부 링크로의 사용한다. 그 사용 방법에 대해서 살펴 보도록 하겠다.먼저 관련 항목의 위치 정보를 문자열을 표시하는 경우이다.@see "string" 표시 할 문자열을 쌍따옴표("")로 둘러 싸서 지정한다. 사용하는 방법은 다음과 같다./** * 주석의 설명문 * @see "Java" */ 다음은 외부 사이트로의 링크를 표시하는 경우이다.@se..

@version 태그@version태그는 클래스, 인터페이스 등에 작성하고 소프트웨어의 버전을 지정하기 위해 사용한다.@version version-text 소프트웨어 버전을 지정한다. 작성 위치 : 개요, 패키지, 클래스, 인터페이스 중복 작성 : 가능 출력 형식 : 버전 기 타 : "-version" 옵션 필요 소프트웨어의 현재 버전을 지정하는 경우에 사용한다. 같은 주석 내에서 여러 번 지정할 수 있다./** * 주석의 설명문 * * @version 1.0 * @version Project 2.0.1 */ @version 태그가 중복으로 작성된 경우는 출력 될 때 각각의 버전이 쉼표(,)로 구분하여 한 줄에 모와서 출력된다.비슷한 태그로 @since가 있는데, 이 태그는 현재 버전이 아닌 도입 된 ..

주석에는 설명문과 Javadoc 태그를 작성할 수 있다. 여기에서는 Javadoc 태그에 대해 설명한다. 인수와 반환 값, 예외 및 참고하는 곳의 지정 등 해당 Javadoc 태그와 값이 같이 지정된다. @author 태그@author 태그는 클래스 클래스, 인터페이스 등에 작성하고, 작성자를 지정하는데 사용한다.@author name-text 저자에 관하여 지정한다. 작성 위치 : 개요, 패키지, 클래스, 인터페이스 중복 작성 : 가능 출력 형식 : 작성자 기 타 : "-author" 옵션 필요 주로 클래스 등의 주석을 작성하고, 저자가 누구인지를 지정하는 경우에 사용한다. 같은 주석 내에서 여러 번 지정할 수 있다./** * 주석의 설명문 * @author devkuma * @author kimkc ..

필드에 대한 주석 작성 시에 주의점Java에서는 동일한 데이터 형식의 여러 필드를 한 번에 선언 할 수 있다.int width, height; 이런 형식에 대해서 주석을 작성하게 되면 다음과 같이 작성이 될것이다./** * 폭과 높이를 나타낸다. */ int width, height; 이 경우는 두 변수에 같은 주석이 적용된다. 결과적으로 다음과 같이 작성했을 경우와 동일하다./** * 폭과 높이를 나타낸다. */ int width; /** * 폭과 높이를 나타낸다. */ int height; 경우에 따라서는 이러한 형식으로도 문제없는 경우도 있겠지만, 대부분의 경우는 적절한 주석가 되지 않는다. 그러기에 Javadoc를 이용하는 경우에는 필드마다 선언하고, 별도의 주석을 하도록 한다.쌤플간단한 예제를 ..

HTML문 작성Javadoc으로 작성된 문장은 HTML 문으로 해석되어 표시된다. 반대로 말하면 HTML 문으로 작성해야 한다면, 태그가 아닌 문자 코드로 작성해야 한다. 예를 들어 "