[Clean Code] 4 : 주석

안녕하세요 :) Zedd입니다.

클린코드 4장!!! 주석입니다. 읽으면서 가장 정말 가장 뜨끔뜨끔 거렸던.....챕터였어요....나잖아..?하는 말도 많고.....반성을 많이 하게 된 챕터여씀

시작할게요!XD 

주석

---

---

나쁜 코드에 주석을 달지 마라. 새로 짜라. 

- 브라이언 W. 커니핸, P.J.플라우거-

---

크.......

잘 달린 주석은 그 어떤 정보보다 유용하다. 경솔하고 근거없는 주석은 코드를 이해하기 어렵게 만든다.

오래되고 조잡한 주석은 거짓과 잘못된 정보를 퍼뜨려 해악을 미친다.

사실상 주석은 기껏해야 필요악이다.

우리에게 프로그래밍 언어를 치밀하게 사용해 의도를 표현할 능력이 있다면, 주석은 전혀 필요하지 않으리라.(진짜 인정..)

우리는 코드로 의도를 표현하지 못해, 그러니까 "실패"를 만회하기 위해 주석을 사용한다. 

주석은 언제나 실패를 의미한다. 때때로 주석없이는 자신을 표현할 방법을 찾지 못해 할 수 없이 주석을 사용한다.

그래서 주석은 반겨맞을 손님이 아니다.

그러므로 주석이 필요한 상황에 처하면 곰곰이 생각하기 바란다. 주석을 달 때 마다 자신에게 표현력이 없다는 사실을 푸념해야 마땅하다(...........)

내가 이렇게 주식을 무시하는 이유는, 주석은 거짓말을 하니까.

항상도 아니고 고의도 아니지만 너무 자주 거짓말을 하니까. 주석은 오래될수록 코드에서 멀어진다. 

코드는 변화하고 진화한다. 일부가 여기서 저기로 옮겨지기도 한다. 불행히도 주석이 언제나 코드를 따라가지는 않는다.

부정확한 주석은 아예 없는 주석보다 훨씬 나쁘다. 코드만이 자기가 하는 일을 진실되게 말한다. 코드만이 정확한 정보를 제공하는 유일한 출처다. 그러므로 우리는 주석을 가능한 줄이도록 꾸준히 노력해야한다. 

● 주석은 나쁜코드를 보완하지 못한다.

- 코드에 주석을 추가하는 일방적인 이유는, 코드 품질이 나쁘기 때문이다. 지저분한 모듈이라는 사실을 자각한다. 그래서 자신에게 이렇게 말한다. "이런! 주석을 달아야겠다!" ==> 아니다!!! 코드를 정리해야한다.

- 표현력이 풍부하고 깔끔하며 주석이 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다. 

- 자신이 저지른 난장판을 주석으로 설명하려 애쓰는 대신에 그 난장판을 깨끗이 치우는데 시간을 보내라!!!!!!!!!

● 코드로 의도를 표현하라!

- 확실히 코드만으로 의도를 설명하기 어려운 경우가 존재한다.

//직원에게 복지 혜택을 받을 자격이 있는지 검사한다. 
if (employee.flags && HOURLY_FLAG) && employee.age > 65

 

다음 코드는?

if employee.isEligibleForFullBenefits()

 

- 몇 초만 더 생각하면 코드로 대다수 의도를 표현할 수 있다.

● 좋은 주석

- 어떤 주석은 필요하거나 유익하다. 지금부터 "글자 값"을 한다고 생각하는 주석 몇가지를 소개한다. 하지만 정말로 좋은 주석은. 주석을 달지 않을 방법을 찾아낸 주석이라는 것을 명심하라.

○ 법적인 주석

- 법적인 이유인한 특정 주석. 각 소스파일 첫머리에 줫ㄱ으로 들어가는 저작권 정보와 소유권 정보는 타당하다.

○ 정보를 제공하는 주석

- 기본적인 정보를 주석으로 제공하면 편리하다.

//테스트중인 Responder 인스턴스를 반환한다.
(..코드)

 

위와같은 주석이 유용하다 할지라도, 가능하다면 함수 이름에 정보를 담는 편이 더 좋다.

○ 의도를 설명하는 주석

- 때때로 주석은 구현을 이해하게 도와주는 선을 넘어 결정에 깔린 의도까지 설명한다.

==> 이게 무슨뜻이냐면, 내가 코드를 짰는데, 이러이러한 방식으로 코드를 짰다는것을 주석으로 설명하는 것. 소스코드를 읽는 사람이 이 코드를 짠 사람의 문제 해결 방식에 동의하지 않을지라도 "왜" 이렇게 코드를 작성했는지 주석을 통해 이해할 수 있다. 

○ 결과를 경고하는 주석

- 때로 다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용한다.

//여유 시간이 충분하지 않다면 실행하지 마십시오.
(..코드)

 

다음은 주석이 아주 적절한 예제다.

//SimpleDataFormat은 스레드에 안전하지 못하다.
//따라서 각 인스턴스를 독립적으로 생성해야한다.
(...코드)

 

○ TODO주석

- 때때로는 앞으로 할 일을 //TODO주석으로 남겨두면 편하다.

- TODO주석은 프로그래머가 필요하다 여기지만 당장 구현하기 어려운 업무를 기술한다.

- 하지만 어떤 용도로 사용하든 시스템에 나쁜 코드를 남겨놓는 핑계가 되어서는 안된다.

- TODO로 떡칠한 코드는 바람직하지 않다. 그러므로 주기적으로 TODO주석을 점검해, 없애도 괜찮은 주석은 없애라.

○ 중요성을 강조하는 주석

- 자칫 대수롭지 않다고 여겨질 뭔가의 중요성을 강조하기 위해서도 주석을 사용한다.

● 나쁜 주석

-  대다수의 주석이 이 범주에 속한다.

- 일반적으로 대다수 주석은 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화 하는 등 프로구래머가 주절거리는 독백에서 크게 벗어나지 못한다.(죄송합니다.....잘못했스빈다....)

 

○ 주절거리는 주석

- 특별한 이유없이 의무감으로 혹은 프로세스에서 하라고 하니까 마지못해 주석을 단다면 전적으로 시간낭비다. 이해가 안되어 다른 모듈까지 뒤져야 하는 주석은 독자와 제대로 소통하지 못하는 주석이다. 그런 주석은 바이트만 낭비할 뿐이다. 

- 주석을 달기로 결정했다면 충분한 시간을 들여 최고의 주석을 달도록 노력한다.

○ 같은 이야기를 하는 주석

- 코드내용을 그래도 중복하는 주석은 자칫하면 코드보다 주석을 읽는 시간이 더 오래 걸릴 수 있게 한다.

- 주석이 코드보다 더 많은 정보를 제공하지 못한다면? 코드를 정당화하는 주석도아니고 의도나 근거를 설명하는 주석도 아니고 코드보다 읽기 쉽지 않은 주석은 독자가 코드를 대충 이해하고 넘어가게 만든다.

○ 의무적으로 다는 주석

- 모든 변수에 주석을 달아야 한다는 규칙은 어리석기 그지없다. 이런 주석은 코드를 복잡하게 만들며, 거짓말을 퍼뜨리고 혼동과 무질서를 초래한다.

○ 이력을 기록하는 주석

- 때때로 사람들은 모듈을 편집할 때마다 모듈 첫머리에 주석을 추가한다.  첫머리 주석은 모듈에 가한 변경을 모두 기록하는 일종의 일지 혹은 로그가 된다. 

- 하지만 이제는 소스코드 관리 시스템이 있으니 완전히 제거하는 편이 좋다.

○ 있으나 마나한 주석

- 너무나도 당연한 사실을 언급하며 세로운 정보를 제공하지 못하는 주석

//이니셜라이저.
init() {}

 

- 위와같은 주석은 지나친 참견이라 개발자가 주석을 무시하는 습관에 빠진다. 코드를 읽으며 자동으로 주석을 건너뛴다. 

○ 함수나 변수로 표현 할 수 있다면 주석을 달지마라.

○ 위치를 표시하는 주석

- 특정 위치를 표시하려 주석을 사용한다. 

//Action/////////////////////////////

 

위와같은 주석은 가독성만 낮추므로 제거해야 마땅하다. 

- 너무 자주 사용하지 않는다면 배너는 눈에 띄며 주의를 환기한다. 그러므로 반드시 필요할 때만, 아주 드물게 사용하는 편이 좋다. 배너를 남용하면 독자가 흔한 잡음으로 여겨 무시한다.

○ 닫는 괄호에 다는 주석

- 닫는 괄호에 특수한 주석을 달아놓는다.

 while(true){

      (..코드)

}//while

 

중첩이 심하고 장황한 함수라면 의미가 있을지도 모르지만, 우리가 선호하는 작고 캡슐화된 함수에는 잡음일 뿐이다. 그러므로 닫는 괄호에 주석을 달아야겠다는 생각이 든다면, 대신에 함수를 줄이려 시도하자. 

○ 공로를 돌리거나 저자를 표시하는 주석

/* Zedd가 추가함 */

 

소스코드 관리 시스템은 누가 언제 무엇을 추가했는지 귀신처럼 기억한다 저자이름으로 코드를 오염시킬 필요가 없다.

○ 주석으로 처리한 코드

- 주석으로 처리한 코드만큼 밉살스러운 관행도 드물다(뜨끔)

- 주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다. 이유가 있어 남겨놓았으리라고, 중요하니까 지우면 안된다고 생각한다. 이렇게 점점 쓸모없는 코드가 점차 쌓여간다.

- 소스코드 관리 시스템이 우리를 대신에 코드를 기억해준다. 이제는 주석으로 처리할 필요가 없다. 그냥 코드를 삭제하라. 잃어버릴 염려는 없다.

○ HTML주석

- 혐오 그 자체 (저는 HTML주석이라는 걸 첨봐요..극혐이라니까 쓰지맙시다.)

○ 전역정보

- 주석을 달아야한다면 근처에 있는 코드만 기술하라. 코드 일부에 주석을 달면서 시스템 전반적인 정보를 기술하지 마라.

○ 너무 많은 정보 

- 주석에다 흥미로운 역사나 관련없는 정보를 장황하게 늘어놓지 마라 == 구구절절충이 되지마라. 

○ 모호한 관계

- 주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다. 이왕 공들여 주석을 달았다면 적어도 독자가 주석과 코드를 읽어보고 무슨소리인지 알아야 하지 않겠니? 

- 주석을 다는 목적은 코드만으로 설명이 부족해서다. 주석 자체가 설명을 요구하는 주석은 정말 안타깝

○ 함수 헤더

- 짧은 함수는 긴 설명이 필요없다. 

- 짧고 한가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋다. 

여러분..결론은...

"우리에게 프로그래밍 언어를 치밀하게 사용해 의도를 표현할 능력이 있다면, 주석은 전혀 필요하지 않으리라."

코드를 잘짜면 됩니다. 

"일반적으로 대다수 주석은 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화 하는 등 프로구래머가 주절거리는 독백에서 크게 벗어나지 못한다."

내 코드를 합리화하려 하지 맙시다.