자바(Java) 주석 Comments 소스 내에 작성하는 방법

자바 언어의 기본 구성 요소 중 하나인 주석은 소스 내에 작성한 코드를 설명할 때 추가하게 됩니다. 코드의 이해를 돕는 주석문은 소스에 영향을 주지 않습니다. 하지만 과도한 주석은 성능에 영향을 줄 수 있으며 차후에 보게 될 사람들에게 혼란을 줄 수 있습니다. 주석은 필요한 핵심만 적는 것이 좋고 특수문자를 포함하면 안됩니다. 오늘은 주석의 종류와 샘플에 대한 이야기를 하겠습니다.

 

 

▼ 문자열로 취급되는 주석문의 종류는 3가지 있습니다. 1번과 2번은 구현주석으로 개별적 구현에 대한 주석입니다. 그와 달리 3번은 문서주석으로 API 나 도움말 만들 때 쓰는 주석입니다. 그래서 클래스의 시작 부분에 추가를 합니다.

 

①   // 주석문 : // 표시부터 그 줄의 끝까지 위치한 모든 문자를 주석으로 간주한다.

 

②   /* 주석문 */ : 줄 수와 상관없이 “/*” 시작과 “*/” 끝 사이에 있는 모든 문자를 주석으로 간주한다. 여러 줄의 주석이 가능하므로 긴 설명을 하거나 많은 양의 소스를 주석으로 처리하고 싶을 때 이용한다.

 

③   /** 주석문 */ : 줄 수와 상관없이 “/**” 시작과 “*/” 끝 사이에 있는 모든 문자를 주석으로 간주한다. 클래스의 선언부, 멤버, 생성자 등 클래스 인터페이스 시작 부분에 사용해야 한다. 이 주석은 소스를 라이브러리로 만들 때 공식 문서용으로 뽑아 사용할 수 있다. javadoc 시스템을 사용하여 API 문서나 도움말 등에 이용된다.

 

 

 

◎ 구현주석의 예제

 

 

▼ End of line 주석으로 한 줄 모두를 주석처리 하거나 한 줄의 일부분을 주석처리 할 때 이용합니다. 다음 줄로 넘어가면 주석처리가 안되며 여러 줄 연속으로 사용하려면 줄 마다 추가를 해 줘야 합니다.

 

public class Split {
 
	public static void main(String[] args) {
						
		String str1 = "phone;name;id;pwd";
		String[] words1 = str1.split(";", 0);
		String[] words2 = str1.split(";", 2);
		
		System.out.println("0 일때 : ");
		for (String wo : words1 ){
			System.out.println(wo);
		}
		
//		System.out.println("\r\n2 일때 : ");
//		for (String wo : words2 ){
//			System.out.println(wo);
//		}
	}
}

 

 

▼ Block 주석으로 파일, 메서드, 알고리즘에 대한 설명을 할 때 이용합니다. 여러 줄을 표현할 때 사용하게 되는데 /* */ 내부에 있는 글은 모두 주석이 됩니다. 형태는 여러가지로 만들 수 있습니다.

public class Split {
 
	public static void main(String[] args) {
						
		String str1 = "phone;name;id;pwd";
		String[] words1 = str1.split(";", 0);
		String[] words2 = str1.split(";", 2);
		
		/*내용 출력*/
		System.out.println("0 일때 : ");
		for (String wo : words1 ){
			System.out.println(wo);
		}
		
/*		System.out.println("\r\n2 일때 : ");
		for (String wo : words2 ){
			System.out.println(wo);
		}*/
	}
}

 

 

◎ 문서주석의 예제

 

 

▼ 자바클래스나 인터페이스, 생성자, 메서드 등을 설명할 때 이용하며 ‘/** */’ 경계기호를 사용합니다. 각 라인의 앞에는 * 로 시작합니다. 나중에 API 문서나 도움말을 만들 때 이용하기 위해 여러 요소들이 추가 되었습니다. <pre></pre> 태그 내부에는 주로 수정 이력에 대한 내용이 들어갑니다. 귀찮더라도 아래와 같이 작성해서 소스 이력을 관리하시는 것이 좋습니다.

 

/**
 * 배열에 내용을 출력한다. 
 * <pre>
 * <b>History:</b>
 *    작성자, 1.0, 216.1.3 최초작성
 * </pre>
 *
 * @author 홍길동
 * @version 1.0, 216.1.3 소스 수정
 * @see    None
 */
public class Split {
 
	public static void main(String[] args) {
						
		String str1 = "phone;name;id;pwd";
		String[] words1 = str1.split(";", 0);
		String[] words2 = str1.split(";", 2);
		
		/*내용 출력*/
		System.out.println("0 일때 : ");
		for (String wo : words1 ){
			System.out.println(wo);
		}
		
		System.out.println("\r\n2 일때 : ");
		for (String wo : words2 ){
			System.out.println(wo);
		}
	}
}

 

※ 아래는 참고하면 좋을 만한 글들의 링크를 모아둔 것입니다. ※ ▶ 자바(Java) 버전 확인하고 최신으로 업데이트 하는 방법 ▶ 윈도우10 자바(Java) 버전 확인하기 ▶ 자바(Java) 개발을 위한 최신 버전 JDK 다운 받기 ▶ 자바(Java) 주석 Comments 소스 내에 작성하는 방법 ▶ 자바(Java) public, private, protected, default