자바 주석 사용 한줄주석 여러줄주석 코드설명 적기

자바에서 주석은 한줄주석과 여러줄주석이 있다. 이들은 코드를 설명하고 다른 사람이 보고 이해할 수 있도록 한다. 또는 시간이 흐른 후 이 코드가 어떤 용도로 사용되는지 복기할 수 있다. 오롯이 기억만에 의지하면 코드를 왜 만들어 두었는지 알 수 없다. 특히 대규모 프로젝트 참여시 정규화된 주석이 따로 있기 때문에 익혀두는 것이 좋다. 추가로 이클립스에서 사용되는 주석 단축키는 ctrl+/ 이다.

자바 주석 사용 한줄주석 여러줄주석

프로그래밍 코딩에서 주석은 프로그램이 어떻게 동작하는지 설명하는 부가적인 설명문이다.

컴파일시 무시되기 때문에 많이많이 작성하면 된다.

주석을 어떻게 작성하느냐에 따라 다른 사람이 어떻게 볼지도 생각할 필요도 있다.

어쨌든 중요한 점은 주석을 작성하는데 있어 육하원칙으로 간단명료하게 작성하면 되는 것이며
보는 사람이 이해하면 그 뿐이다.

주석은 한줄주석과 여러줄 주석 그리고 단축키를 사용하는 방법이 있다.

주석 작성하기

자바에서 주석을 사용하는 방법은 한줄주석과 여러 줄 주석이 있다.

자바 프로그래밍을 하기 위한 이클립스의 주석 단축키는 ctrl + / 을 이용하면 된다.

단축키를 사용하는 것이 편하면 마우스 또는 커서를 이용해 범위를 지정한 후 ctrl + / 을 눌러주면 된다.

자바에서 주석의 형태는 다음과 같다.

참고로 주석은 컴파일시 무시된다.

• 한줄주석 - // 주석내용
• 여러줄주석 - /* 주석내용 */
• 단축키 - ctrl + /

샘플코드

위의 주석을 사용하는 방법으로 주석을 넣어본다.

아래의 코드는 주석이 붙은 상태 그대로 붙여넣은 것이다.

단축키를 이용할 경우 주석의 형태가 줄의 맨 앞에 붙기도 한다.

public class JavaTutorials {
	  
	public static void main(String[] args) {
		
		System.out.println("주석을 표현해 본다.");
		
		// 한 줄 주석 사용
		// System.out.println("한 줄 주석을 표현해 본다.");
		
		/* 여러 줄 주석
		System.out.println("여러 줄 주석을 표현해 본다.");
		*/
		
//		단축키 ctrl + / 를 사용한 주석
//		System.out.println("단축키를 사용한 주석을 표현해 본다.");
	}
}

결과화면을 보자.

컴파일시 무시되고, 실행중에도 무시되는 것을 볼 수 있다.

간단히 코드에 대한 설명문을 추가하고자 할 떄 주석을 사용하여 다른 사람과 공유시 이해할 수 있도록 주석을 작성하는 것이 좋다.