4장. 주석

목차

1. 주석은 나쁜 코드를 보완하지 못한다.
2. 코드로 의도를 표현하라!
3. 좋은 주석
4. 나쁜 주석
5. 느낀점

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

잘 달린 주석은 그 어떤 정보보다 유용하다. 하지만 그렇지 않은 주석은 코드를 이해하기 어렵게 만든다.
우리에게 프로그래밍 언어를 정밀하게 사용해 의도를 표현할 능력이 있다면, 주석은 거의 필요하지 않으리라.
우리는 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다.

주석은 언제나 실패를 의미한다.
그러므로 주석이 필요한 상황에 처하면 곰곰이 생각해보자. 오히려 코드로 의도를 표현할 방법은 없을까?

주석은 오래될수록 코드에서 멀어진다.
이유야 단순하다.
프로그래머들이 주석을 유지하고 보수하기란 현실적으로 불가능하니까.

부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다.

진실은 한 곳에만 존재한다. 바로 코드다.
코드만이 자기가 하는 일을 진실되게 말한다.
그러므로 우리는 주석을 가능한 줄이도록 꾸준히 노력해야 한다.

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

코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다.

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

2. 코드로 의도를 표현하라! (중요)

이번 단원을 읽으며 느꼈던, 사실상 가장 핵심적인 내용이라고 생각한다.
아래 코드를 보며 단번에 이해해보자.

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

vs

if (employee.isEligibleForFullBenefits());

3. 좋은 주석

어떤 주석은 필요하거나 유익하다.
하지만 명심하자. 정말로 좋은 주석은, 주석을 달지 않을 방법을 찾아낸 주석이라는 사실을!

3-1. 법적인 주석

회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣으라고 명시한다.
예를 들어, 각 소스 파일 첫머리에 주석으로 들어가는 저작권 정보와 소유권 정보이다.

3-2. 정보를 제공하는 주석

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

3-3. 의도를 설명하는 주석

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

// 스레드를 대량 생산하는 방법으로 어떻게든 경쟁 조건을 만드려 시도한다.
for(int i = 0; i < 25000; i++) {
...
}

3-4. 의미를 명료하게 밝히는 주석

모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워진다.

3-5. 결과를 경고하는 주석

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

// 여유 시간이 충분하지 않다면 실행하지 마십시오
public void _testWithReallyBigFile(){}

3-6. TODO 주석

앞으로 해야 할 일을 TODO 주석으로 남기면 편하다.

또한, 더 이상 필요 없는 기능을 삭제하라는 알림, 누군가에게 문제를 봐달라는 요청, 더 좋은 이름을 떠올려달라는 부탁, 앞으로 발생할 이벤트에 맞춰 코드를 고치라는 주의 등에도 유용하다.

쪽지나 메모같은 개념이라 생각하자

3-7. 중요성을 강조하는 주석

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

String listItemContent = match.group(3).trim();
// 문자열에 시작 공백이 있으면 다른 문자열로 인식되기 때문에 trim() 중요

3-8. 공개 API에서 Javadocs

설명이 자 된 공개 API는 참으로 유용하고 만족스럽다. 표준 라이브러리에서 사용한 Javadocs가 좋은 예다.

공개 API를 구현한다면 반드시 훌륭한 Javadocs를 작성하자.

4. 나쁜 주석

4-1. 주절거리는 주석

4-2. 같은 이야기를 중복하는 주석

4-3. 오해할 여지가 있는 주석

4-4. 의무적으로 다는 주석

4-5. 이력을 기록하는 주석

우리에겐 git과 github가 있다.

4-6. 있으나 마나 한 주석

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

4-7. 무서운 잡음

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

이는 2. 코드로 의도를 표현하라! 의 내용과 같다고 본다

4-9. 위치를 표시하는 주석

// Actions /////////////////////////////
과 같은 주석은, 너무 자주 사용하지만 않는다면 배너의 역할을 한다.
하지만 잦은 사용은 가독성을 낮추고 더 지저분해 보이게 한다.

4-10. 닫는 괄호에 다는 주석

try {
	while() {
  	...
  	} // while
} // try
catch {
...
} // catch

이와 같은 주석은 중첩이 심하고 장황한 함수라면 유용할 수 있다.
하지만 작고 캡슐화된 함수에는 잡음일 뿐이다.

4-11. 공로를 돌리거나 저자를 표시하는 주석

우리에겐 github가 있다.

4-12. 주석으로 처리한 코드

지우지도, 참고하지도 못하는 애매한 코드다. 마치 애물단지같은..?

4-13. HTML 주석

4-14. 전역 정보

코드 일부에 주석을 달면서 시스템 전반적인 정보를 기술하는 것은 말도 안되는 일

4-15. 너무 많은 정보

주석은 일종의 메모와 같다고 생각한다. 메모는 책이 아니다.

4-16. 모호한 관계

4-17. 함수 헤더

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

4-18. 비공개 코드에서 Javadocs

공개 API는 Javadocs가 유용하지만 공개하지 않을 코드라면 Javadocs는 쓸모가 없다.

5. 느낀점

이번 단원을 읽고 주석, 혹은 각주에 대해 검색해보았다.

주(註) 또는 각주(영어: footnote 또는 annotation 등)는 본문에 대하는 참조 문헌이나 본문의 낱말, 문장 등의 뜻을 알기 쉽게 풀이하는 덧붙이는 글이다.
위키백과

주석은 뜻 그대로 본문에 대하는 참조 문헌이나 본문의 낱말, 문장 등의 뜻을 알기 쉽게 풀이하는 덧붙이는 글이었다.

주석으로 코드를 대신하려고 하지 말자!
주석은 일종의 포스트잇이라고 생각하면 편할 듯하다.

주석을 더 붙일 생각보다 코드를 통해 내 의도를 표현 할 생각을 하자.