코멘트(주석) - 프로그래밍 습관01

코멘트(주석, comment)란?
컴퓨터가 보는 것이 아니다. 대상은 사람이다.(작성자 자신도 포함)
C언어는 /* 주석 */ 으로 여러행에 걸쳐 주석을 넣을 수 있다.
C++, C99, C#, Java에서는 여기에 // 뒤에 한줄로 된 코멘트가 추가된다. 내가 알기론 그렇데 교수님이 수업할 때 학생 중 하나의 말에 따르면 C언어 표준의 최신 정의를 보면 C언어에 //로 된 한줄짜리 코멘트도 인정했다고 한다.
언어마다 comment를 정의하는 문법은 조금씩 다르지만 다들 가지고 있다.
@ comment, #comment, $comment, <! comment --> 등 다양하지만 웬만한 언어는 모두 코멘트를 작성할 수 있도록 지원해준다.
코멘트는 코드와 가장 가까이(내부)에 있는 문서로 코드를 읽어갈 때 방향을 잃지 않도록 도와준다.

코멘트는 적게 사용하는 것이 좋다?
코멘트의 양이 많을수록 코드를 읽기 어려울 수도 있다. 잘못된 코멘트는 심각한 오해를 불러일으키며, 잘못된 코멘트가 아니더라도 양이 많고 위치가 뒤죽박죽이면 읽기 힘들어진다.
코멘트는 오해의 소지가 있는 곳, 읽기 힘든 곳, 알아보기 힘든 곳에서는 반드시 있어야 한다. 하지만 잘 만들어진 코드는 논란의 여지가 없고 알아보기 쉬운 코드이므로 코멘트가 그만큼 줄어든다. 많은 코멘트가 필요없는 코드를 작성하기 위해 시간을 투자하자!

어떻게(How)가 아니라 왜(Why)를 기술하라
코멘트의 기본이다. 그리고 코멘트에서 가장 중요한 부분이다. 어떻게 돌아가는지는 코드를 보면 충분히 알수 있다. 왜 이런 코드를 작성했는지에 대한 것을 적어라. 명심히라. 코멘트는 How가 아니라 Why를 기술해야 한다.

코드를 묘사하지 마라
How를 기술하지 말라는 것과 같은 내용이다. 코드에 있는 사실을 다시 코멘트로 만들지 마라

코드를 대신하지 마라
코멘트가 길어지고 있다면 코멘트를 잘 쓰기보다는 코드를 알아보기 쉽게 고치도록 하자.
코멘트의 내용이 지나치게 중요하다면 코드는 수정되어야 한다.

유용성을 유지하라
- 의외의 것을 기록하라
    일반적이지 않은 코드, 특이한 녀석은 반드시 코멘트를 달고 뻔한 코드는 코멘트를 달지 마라. 특이한 녀석은 적을수록 좋다.
- 진실을 말하라
    잘못된 코드는 오히려 심한 오해를 불러들인다. 코드를 수정하면서 코멘트는 가만히 두는 경우 이런 문제가 발생할 수 있다. 코드를 수정할 때 코멘트도 잘 봐야 한다.
- 가치 있게 만들어라
    농담, 비속어, 이모티콘, 장난, 암호 금지... 장난치지 마라. 당신은 지금 얼마나 오래갈지 모르는 소스를 만들고 있다.
- 명료하게 만들어라
    구체적이고 정확하게 써라. 누군가 당신의 코멘트를 읽고 무슨 뜻인지 몰라 어리둥절해지면 당신은 코드를 악화시킨 것이다.

블록의 끝을 무조건 //end of if( a < 1 ) 이런 식으로 하는 것 나쁜 습관이란다. 난 이렇게 하려고 습관들이고 있었는데..
왜냐하면 블록은 한 페이지 안에 들어와야 하고 알아보기 쉽게 되어있어야 하기 때문이란다.

코멘트를 잘 달기보다 이름을 잘 짓는것에 더 투자하라.