슬기로운 개발자 생활

@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...

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

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

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

주석 서식Javadoc로 생성되는 문서의 확인 및 Javadoc에 관련된 주석 작성 방법 등에 대한 Javadoc 기본 사항을 설명한다. 주석의 구성Javadoc에 관계되는 주석의 구성에 대해 알아보자. 다른 페이지에서 확인 했듯이 주석는 다음과 같이 /**에서 */ 사이에 작성한다./** * * 이 사이에 주석을 작성한다. * */ 주석 안은 크게 나누면 '설명문'과 '태그 섹션' 이렇게 두 가지로 구분할 수 있다.설명문은 클래스 또는 메소드 등에 대해 간략하게 설명한 글이다./** * 이 클래스는 Javadoc 설명용 클래스이다. */ 설명문에는 여러 분을 작성할 수 있다. 주석의 시작 부분에서 첫 번째 태그 섹션이 나타날 때까지가 설명문이 된다. 그러나 설명문은 HTML문으로 해석되기 때문에 단순히..

실제로 문서를 만들어 보도록 하자. 아래는 간단한 Java 샘플 코드이다.public class Sample01 { private int w; private int h; public Sample01() { w = 0; h = 0; } public void setSize(int width, int height) { w = width; h = height; } public int getWidth() { return w; } public int getHeight() { return h; } } 이 샘플 코드에 대해서 Javadoc 주석를 작성한 예는 다음과 같다./** * Javadoc 테스트용 클래스 * * @author devkuma * @version 1.0 */ public class Sample01 ..

주석을 작성하는 방법을 확인해 보자. Java로 코멘트를 작성하는 방법과, 그 중에서도 Javadoc의 대상이 되는 주석를 작성하는 방법에 대해서 설명하겠다.Java의 주석 작성 방법Java 소스 코드에 주석를 작성 방법은 다음 두 가지가 있다.블록 주석블록 주석는 /*에서 */로 둘러싸인 부분이 모든 주석이다. 여러 행을 포함 할 수 있으며, 한 줄로도 사용할 수 있다./* 주석 주석 */ /* 주석 */ 한 줄 주석단일 행에 주석을 다는 경우에 //도 사용할 수 있다. 이 경우 //뒤에서 주바꿈까지가 주석이다.// 주석 Javadoc의 대상이 되는 주석 작성 방법Javadoc를 이용하는 경우에도 Java 소스 코드에 작성하는 것과 차이가 없기 때문에 Java 규칙을 따르지만, Javadoc 문서 생성..