본문 바로가기

Develop/JAVA

[JAVA] 자바스터디 : 주석


※ 자바공부를 시작하면서 배우는 하나하나를 부족하더라도 정리해 업데이트 해보고자 한다. 개념상 일부 오류가 있을 수도 있고, 소스코드를 봤을 때 부족하거나 좀더 좋은 형태가 있을 수 있으니 참고만 바란다.



어느 언어든 주석문은 필수다. 한창 해당 프로그램을 작성한다고 각 코드들이 어떤 작용을 하는지 이해하고 있더라도, 시간이 지나면 자연스레 잊어버리가 마련이다. 따라서, 다시 보게 되더라도 어떤 코드인지 반드시 남겨야 하는 주석은 유지보수에 중요한 키 포인트다.

주석은 그 어떤 내용을 입력하더라도 컴파일 할 때 컴파일 대상에서 제외되는만큼, 최대한 잘 적어두는 것이 중요하다.



자바에서의 주석은 블록(block)단위 주석과 행(line)단위 주석으로 나뉜다. 어떤 주석이냐에 따라 주석을 입력할 때 조금 다르다.


1. 블록 단위 주석
/* 로 시작해서 행에 관계없이, */가 있는 곳까지 주석으로 처리한다. (파란색 텍스트가 주석부분이다)

예)
/* 작성시점 : 16년 3월 24일
System.out.println 테스트코드
파일이름 : Print.java */

class Print
{
public static void main(String[] args)
{
System.out.println(7);
System.out.println(3.14);
System.out.println("6+7=" + 6 + 7);
System.out.println("6+7=" + (6 + 7));
System.out.println(7 + "은 정수입니다.");
System.out.println("9-2" + "의 결과는 7입니다");
System.out.println(10+5);
System.out.println(11%10);
}
}


2. 행 단위 주석
말 그대로 행에 한해서만 주석으로 처리하며, // 로 시작한다. (파란색 텍스트가 주석부분이다)

예)
// 작성시점 : 16년 3월 24일
// System.out.println 테스트코드
// 파일이름 : Print.java 

class Print
{
public static void main(String[] args)
{
System.out.println(7);
System.out.println(3.14);
System.out.println("6+7=" + 6 + 7);
System.out.println("6+7=" + (6 + 7));
System.out.println(7 + "은 정수입니다.");
System.out.println("9-2" + "의 결과는 7입니다");
System.out.println(10+5);
System.out.println(11%10);
}
}


예제코드에서는 class 선언 위에 적었지만, System.out.println(11%10); 같은 코드 옆에 적어도 된다.