Java (자바)

[Java] 자바 주석 사용하기

Oscar:) 2022. 4. 14. 14:23

주석의 정의

 

우리는 외국어로 코드를 작성한다.

작성한 코드의 양 또한 방대해질 것이다.

그리고 무엇보다,  내가 작성한 코드는 나만의 코드이다.

 

그렇기에 우리는 주석을 사용해야 한다.

 

 

 주석을 사용함으로써 얻는 이점은 생각보다 훨씬 많다.

- 처음 접하는 내용을 메모해가며 공부할 수 있어서, 이제 막 코딩에 입문한 초보자들에게 큰 도움을 준다.

- 코드의 양이 많아졌을 때에도, 영향 범위 등을 구분하여 깔끔하게 정리해줄 수 있다.

- 본인이 코드내에서 직접 정의한 변수, 메서드, 클래스 등 본인만의 스타일이 담긴 코드를
  다른 사람들이 보더라도, 보다 쉽게 이해하도록 도와줄 수 있다.

- 코드를 활성화 / 비활성화할 때에도 사용하기 간편하다.

 

주석 사용하는 방법 : // (슬래시 2개)

 

코드를 뜻풀이 하는 느낌으로 주석을 사용할 수 있다.

 


주석이 처리된 부분은 컴파일되지 않는다는 점을 이용하여,

코드를 활성화 / 비활성화할 때에도 자주 사용한다.

 

아무리 안쓰는 코드라도, 지워버리기에는 조금 찝찝할 때 사용한다.

(= 나중에 다시 사용하게될 여지를 느낄 때)

 


많은 양을 주석 처리해야할 때에는 위 코드처럼

/* 내용 */

이렇게 사용할 수 있다.

 


주석 처리할 부분을 드래그하고, 「 CTRL + / 」 단축키를 사용할 수도 있다.

 


코드의 내용이 많아졌을 때 & 중괄호 처리가 복잡할 때

 

코드의 영향 범위를 주석으로 처리하면, 머릿속을 정리하는데 도움이 될 것이다.

 


지금도 가끔씩, 본인이 작성한 옛 코드를 보면, 단번에 알아보기 어려울 때가 있다.

 

옛 코드를 볼때마다, 주석 처리를 귀찮아 했던 과거의 나에게 조그마한 원망을 남긴다.

 

지금까지도 주석을 습관화하려고 노력중이다.

 

(개인적으로, 주석은 많으면 많을수록 좋다고 생각한다)