Chapter 01-04 주석문

01-04.1 주석

  Def) 주석: 프로그램의 코드와 실행에 영향을 주지 않으며 구현 주석과 문서화 주석으로 나뉜다. 

  - 주석은 코드를 작성할 때 반드시 사용한다.

<hide/>

public class HelloWorld{
	프로그램의 시작점 
    public static void main(String args[]){
        System.out.println("Hello World");
    }

}

  그런데 위 처럼 "프로그램의 시작점"이라는 설명을 넣고 컴파일 하면 에러가 발생한다. HelloWorld리는 클래스가 동작    할 때 "프로그램의 시작점" 이라는 행도 같이 뭔가를 하려 하기 때문이다. => "컴파일 에러"

 

  Def) 컴파일: 사람이 알아보기 쉽게 자성한 코드를 컴퓨터가 알아들을 수 있는 언어로 번역하는 과정을 말한다. 

  Def) 컴파일러: 컴퓨터가 이해하도록 변환하는 프로그램

 

  - 따라서 컴파일 에러 없이 코드에 설명을 남기려면 주석 처리가 필요하다. 

<hide/>

public class HelloWorld{
//	프로그램의 시작점 
    public static void main(String args[]){
        System.out.println("Hello World");
    }

}

  - 위와 같이 문장 앞에 "//"를 추가해서 주석처리하면 컴파일 에러가 없어진다.  

 

<hide/>

public class HelloWorld{
//프로그램의 시작점	
	public static void main(String args[]){
			
		System.out.println("Hello World");
		System.out.println("test");
		System.out.println("1");
		System.out.println("2");
		System.out.println("3");
			
	}		
		
}

  Note) 실행결과

    이렇게 출력 되는데 test행 맨 앞에 //를 추가하면 "test"는 주석 처리 되서 제외하고 출력된다. 

  - 여러 줄을 주석처리 하기 위해서는 블록 지정한 다음 Ctrl + / 하면 자동으로 "//"가 맨 앞에 생겨 주석처리가 된다. 

  - 주석 처리 하려는 부분을 블록 지정한 후, Ctrl + Shift + / 하면  /*  */으로 주석처리가 된다. 

  - 주석 처리를 해제하려면 블록 지정한 후, Ctrl + Shift + \(역슬러시) 를 하면 된다.

 

  - 지금까지 배운 구현 주석과 다르게 문서를 만들 때 사용하는 문서화 주석이 있다.

  Def) 문서화 코드: 코드에서 사용한 클래스가 뭐하는 건지 클래스 내 메서드는 뭐 하는 건지 사용하는 사람이 쉽게 이          해하도록 자바에서 문서화 코드를 만들 수 있다. 

  Def) 문서화 주석: 문서화 코드를 만드는 주석이며 코드의 명세사항을 포함하며 자바 클래스, 인터페이스, 생성자 메서          드 , 필드를 설명할 때 사용한다. /**로 시작하여 */로 끝난다.    

  Note) 

<hide/>


public class HelloWorld{
//프로그램의 시작점	
	/**
	 * 
	 * @param args
	 */
	
	public static void main(String args[]){
		
		System.out.println("Hello World");
		System.out.println("test");
		System.out.println("1");
		System.out.println("2");
		System.out.println("3");
		
	}		
		
}

  코드 중간에 /**를 입력하고 Enter를 누르면 문서화주석 부분에 여기에 들어있는 파라미터가 뭔지 이 클래스를 누가      무슨 용도로 만들었는지 설명이 나온다. HelloWorld코드의 문서화 주석에는 어떤 파라미터(args)가 들어있는지만 나온    다.