자바 기초, 주석문 어떻게 쓰는거지?

자바를 공부하거나, 사용하다 보면 해당 코드에 설명을 쓰고 싶은 경우가 있다.

하지만, 코드 바로 옆에 설명을 쓰면 컴퓨터가 느끼기에는 프로그램 실행과 상관없이 설명하는 문구라고 알아서 분류하지 못한다. 나는 설명이라고 쓴 것도 컴퓨터는 명령어로 인식해서 컴파일 단계에서 오류 메시지를 뿌리게 된다.

1번 라인 처럼 설명을 코드 안에 쓰게 되면 아래와 같은 오류메시지가 뜬다.

컴파일 시에 문제가 발생해서 내가 원하는 a의 값을 화면에 출력해 주지 않는다.

하지만 //으로 주석문 처리를 하면 프로그램이 문제 없이 돌아간다.

내가 원하는 결과인 a의 값이 5가 화면에 출력된다.

자바를 공부하는 사람을 주석문을 나중에 다시 해당 코드를 보더라도 바로 이해가 가게 설명을 해 놓고 싶은 경우에 사용하면 좋다. 

주석문은 실제 프로그램에 영향을 주지 않으며 단지 소스코드의 기능이나 동작을 설명하기 위해 사용되는 것으로,  컴파일 단계에서 제외되기 때문에 실제 프로그램에 영향을 주지 않는다.

주석문은 프로그래머 자신이나 다른 개발자들이 그 소스코드를 보고 프로그램의 내용을 쉽게 파악할 수 있도록 도움을 주기 위해서 사용한다. 주석문안에는 한글을 쓰거나, 특수문자를 써도 아무런 오류가 발생하지 않는다. 주석문 안에는 명령어나, 코드를 넣어도 실행되지 않아 프로그램 실행 시 아무런 영향이 없다.

주석처리 방법은 2가지가 있다. 

// 한줄 주석 처리

/*

여러줄

주석 처리

*/

//

이렇게 쓰면 한줄만 주석처리가 된다. //의 뒷 문장부터 주석으로 처리된다.

보통 변수나 메소드에 대한 설명을 할 수 있고, 추후 코드를 볼때 분명하게 설명하기 위해서 사용하기도 한다. 

/* 주석처리 하고자 하는 문장 */

아래와 같이 사용한다. 주석문을 사용하는 이유는 프로그램 코딩을 하다보면 다양한 메소드를 만들거나 변수를 만들게 된다. 이 후 다시 코드를 확인 할 때 용이 하게 하는 부분도 있고, 혼자가 아닌 다른 개발자와 작업하는 경우 관련 내용을 알려주기 위해 쓰기도 한다.

또한, 프로그램의 오류가 발생하는 경우 어디가 문제인지 주석문으로 막아 놓고 테스트를 하면서 논리적 오류를 해결하는 디버깅 위해 주석물을 활용하기도 한다. 

/*

[여러줄 주석 처리]

프로그램에 영향 없이 설명이

필요한 것을 적을 때 사용한다! 

*/

주석문 사용 방법

public class Test //한줄 주석문 : 메인메소드가 있는 클래스명은 저장파일명과 동일해야 한다.
{
 
    public static void main(String[] args) {
        
        int a = 3+2;
        System.out.print(a);
        
        /* 여러 줄 주석문
         System.out.print();
         는 화면에 출력해 달라는 명령어입니다.
         ( ) 안에 출력하고자 하는 것을 넣으면 됩니다!!!
        */
    }
}

간단하게 주석문을 어떻게 사용하는지 이클립스에서 활용해 보면 더 명확하게 기억이 날 것이다.