#02-04 주석 - <점프 투 자바>

 

출처 : https://wikidocs.net/book/31

 

점프 투 자바

 

 

 

 

 

 

필사 :

 

프로그램 소스코드에 프로그래머의 의견이나 설명을 적을 수 있는데

이런 것을 주석(Comment)이라고 한다.

 

주석은 프로그램 소스에 삽입하더라도

프로그램 수행에 전혀 영향을 끼치지 않는다.

왜냐하면 컴파일 시 주석은 자동으로 제외되기 때문이다.

 

 

 1. 두 가지 주석

    1-1. 블록 주석

    1-2. 라인 주석

 2. 주석이 적은 코드, 많은 코드, 어떤게 좋은 코드인가?

 3. 적절하지 못한 주석

 4. 주석 사용 시 주의할 점

 5. 임시 백업

 

 

 

 

1. 두 가지 주석

자바에는 두 가지 형태의 주석이 있다.

 

 

  1-1. 블록 주석

블록주석은 다음과 같이 작성한다

/*
프로그램의 저작권

이 프로그램의 저작권은 홍길동에게 있습니다.
Copyright 2013.
*/
public class MyProgram {
     ···

/*가 블록주석의 시작이고 */가 블록주석의 끝이다.

 

보통 블록주석은 소스 코드 내에서

한 블록(메소드, 클래스, 일정부분)에 대한 설명을 할 때 주로 사용한다.

 

 

 

 

1-2. 라인 주석

라인 주석은 다음과 같이 작성한다.

int age; // 동물의 나이

// 기호를 이용하면 // 기호가 시작된 곳부터 해당 라인의 끝까지가 주석문이 된다.

보통 코드의 특정부분(한 라인)에 대한 설명이 필요한 경우

해당 라인에 위와 같은 라인 주석을 사용한다.

 

 

 

 

주석이 적은 코드, 많은 코드, 어떤게 좋은 코드인가?

혹자는 주석이 없는 코드가 좋은 코드라고 한다.

이 말을 오해하지는 말자.

 

주석이 없는 코드가 아니라 주석이 있을 필요가 없을 정도로

이해하기 쉽고 누가봐도 명확한 코드를 말하는 것이다.

 

 

이런 코드를 "Simple Code"라고 하는데

XP(Extreme Programing)의 창시자 중 한 명인 론 제프리즈(Ron Jeffries)는

'Simple Code'를 다음과 같이 정의했다.

   "Clean code that works"

"동작하는 깨끗한 코드", 이상적인 코드라고 할 수 있겠다.

 

 

하지만 내용도 불분명하고 도저히 이해불가한 코드에 주석은 필수적이다.

또한 헷갈리기 쉬운 부분도 주석은 꼭 필요하다.

 

 

주석은 이해하기 어려운 곳에 주로 작성되기 때문에

"주석이 필요하다면 좋은 코드가 아니다"라는 말이 나온 것이다.

 

하지만 Simple Code를 작성할 수 없는 입장이라면

주석은 어쩔 수 없이 꼭 필요하다.

 

 

 

 

적절하지 못한 주석

다음의 예처럼 누구나 알고 있는 뻔한 내용의 주석을 다는 것은

소스코드를 지저분하게 만들뿐이다.

a++; // a의 값을 증가

 

 

 

 

주석 사용 시 주의할 점

주석 사용 시 주의할 점이 있다.

그것은 주석의 내용도 소스코드가 변경되면 업데이트 되어야 한다는 점이다.

 

소스코드는 변경이 되었는데 주석문은 수정을 안 하는 경우가 종종 있다.

귀찮아서, 바빠서 그럴 수도 있지만 소스코드에 달린 엉뚱한 주석문은

소스코드를 읽는 다른 이에게 엄청난 혼란을 주게 된다.

 

 

 

 

임시 백업

주석을 사용하는 또 다른 이유는 현재 작성한 소스코드의 특정 부분을

잠시 사용하지 않게 만들고 싶은 경우에도 사용한다.

 

예를들어 기존의 코드보다 좀 더 업그레이드 된 코드를 작성하고 싶은 경우

기존 코드를 모두 삭제하고 시작하는 것이 아니라

잠시 주석처리하고 새로운 코드를 만드는 것이 유리하다.

 

주석처리한 기존코드를 참고할 수도 있고

최악의 경우에 기존의 코드로 쉽게 돌아갈 수 있기 때문이다.

(주석만 해제하면 된다.)

 

 

 

 

 

느낀점 : 

 

주석에 적을 내용이 많을 경우나

공유한 소스코드에 대한 정보를 적을 경우

블록주석을 활용하자.

 

짧은 설명이나 의견은 라인주석을 활용하자.

 

최대한 주석이 필요없을 정도로

이해하기 쉽게 코드를 짜도록 노력하자!

 

기존 코드 수정 시에도 주석을 활용하자