[kr-dev] 코드에 주석(Comment)를 달아보자! - Java(3)

가끔 프로그래머분들이 작성한
소스코드를 뜯어보면

코드이외의 주석(Comment)이
달려있는 것을 보셨을거에요 :)

마치 이런식으로요!

프로그래머는 코드이외에도
필요에 따라 주석을 달기도 합니다.

보통 코드에 자신의 의견을 보충하거나
제3자가 코드를 보았을 때
알아보기 쉽게 만들기 위함입니다.

주석(Comment)의 종류는 크게
두가지로 나뉩니다.

코드 한줄을 주석으로 만드는
라인(Line)주석과

지정된 영역을 모두 주석으로 만드는
블록(Block)주석이죠

라인(Line) 주석

위 그림은 라인or한줄 주석을 이용한
소스코드입니다.

보통 라인주석은 변수에 대한 설명이나
간단한 의견보충을 위해 사용됩니다.

참고로 주석은 코드의 결과에는 영향을
주지 않습니다.

컴파일 과정에서 주석은 제외되기 때문이죠

블록(Block)주석

다음은 블록(Block)주석에 대한 그림입니다.

블록주석은 범위주석이라고도 불리며,
보통 긴 의견보충에 쓰입니다.

또한 라인주석과 다르게
블록 주석은 시작과 끝이 존재합니다.

시작은 /*
끝은 */
로 묶어주게 됩니다.

라인주석과 마찬가지로
소스코드의 결과에는 영향을 주지 않습니다.

따라서, 위의 그림과 같이
1.11, 2.22, 3.33이라는 결과값이
깔끔하게 출력이 되는 것이지요.

보통 저를 포함한 많은 분들이
프로그래밍 입문단계에서
주석으로 도배를 합니다.

하지만 주석이 많은 코드가
좋은 코드는 아니라고 합니다.

코드의 길어질수록
코드를 보기 힘들어지기 때문입니다.

제일 이상적인 코드는
주석이 필요없을 정도로 직관적이고
깔끔한 코딩을 하는것인데

사실상 그건 불가능에 가까운 일이지요 :)

결국 주석은 최소화하고
남들도 쉽게 알아볼 수 있는
깔끔하고 직관적인 코딩을 하는것이
프로그래머의 소양이라 할 수 있는데

주석을 남발하는 저는
아직 갈길이 먼것같습니다 :(