[Java] 주석 사용법

3줄 요약

   //      :  한줄 주석

/*   */   :  다중 주석

문자열에는 주석 금지

---

코드를 작성하다 보면

클래스와 함수 개수가 늘어나면서

어느새 자신의 기억력으로는 감당이 안되는데

 

그래서 나중에 다시봐도 알아볼 수 있도록

작게 메모를 기재하는게 주석(comment)이다.

 

자신은 기억력에 자신이 있다고

주석을 쓰는 습관을 들이지 않으면

 

중요한 때에 기억나지 않고

상사와 고객사에게 영혼까지 털리게 된다.

 

아! 그때 그건데 기억이 안나네!

 

그러므로 평소에 주석을

자주 쓰는 습관을 가지는게 좋다.

 

Java에서 주석을 사용하는 여러 방법이 있는데

 

 

1. 한줄 주석

 

   //    으로 사용할 수 있는데

간단한 메모를 할 때 주로 사용한다.

단축키는  ctrl + / 

public static void main(String[] args) {
			
		// Server 신호 값 체크		
		checkServerFlag();
	}

 

너무 간단한거 아닌가 싶지만

저 작은 단서가 지옥에서 불타고 있는 와중에

한줄기 구원의 동아줄이 될 수 있다.

 

 

2. 범위 주석, 다중 주석, 멀티 주석

 

언어마다 부르는 명칭이 다양한데

    /*    */       으로 범위를 지정해서 사용할 수 있고

여러 줄의 문서를 작성할 때 주로 사용한다.

단축키는   ctrl + shift + /  

 

public static void main(String[] args) {
			
		/* 
		 * blog name : Tyen
		 * Date : 2022.11.02
		 * 
		 * 서버에서 수행한 기능 flag 값을 체크하는 함수입니다.
		 */
		checkServerFlag();
	}

 

주석은 컴파일러가 무시하기 때문에

위키마냥 수백줄을 기재해도

프로그램 성능이 떨어지지는 않으므로

안심하고 적극적으로 사용하는 것을 권장한다.

 

 

그래도 주석을 사용할 때 주의 할 것이 있는데

문자열 안에서는 주석이 문자로 인식된다.

 

즉, 프로그램에 주석 내용이 그대로 출력되므로

문자열을 의미하는 큰 따음표  "  에는

기재하지 않도록 하자

 

 

주석 사용법을 알았으니

이제 주석을 어떻게 활용하는지 알면 좋지 않은가

Java 주석 활용법