TIL (Today I Learned)

2022.02.24 ~ 2022.02.25

오늘 읽은 범위

4장. 주석

책에서 기억하고 싶은 내용을 써보세요.

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

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

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

주석이 필요한 상황에 처하면 곰곰이 생각하기 바란다. 상황을 역전에 코드로 의도를 표현할 방법은 없을까? 코드로 의도를 표현할 때마다 스스로를 칭찬해준다. 주석을 달 때마다 자신에게 표현력이 없다는 사실을 푸념해야 마땅하다.

부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다. 부정확한 주석은 독자를 현혹하고 오도한다. 부정확한 주석은 결코 이뤄지지 않을 기대를 심어준다.

진실은 한곳에만 존재한다. 바로 코드다. 코드만이 자기가 하는 일을 진실되게 말한다. 코드만이 정확한 정보를 제공하는 유일한 출처다.

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

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

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

코드로 의도를 표현하라!

많은 경우 주석으로 달려는 설명을 함수로 만들어 표현해도 충분하다.

좋은 주석

정말로 좋은 주석은, 주석을 달지 않을 방법을 찾아낸 주석이라는 사실을!

• 법적인 주석
  ex) 각 고스 파일 첫머리에 주석으로 들어가는 저작권 정보와 소유권 정보

• 정보를 제공하는 주석

• 의도를 설명하는 주석

• 의미를 명료하게 밝히는 주석

• 결과를 경고하는 주석

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

• 중요성을 강조하는 주석

• 공개 API에서 Javadocs

나쁜 주석

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

• 주절거리는 주석
  코드 작성자에게만 의미있는 주절거림

• 같은 이야기를 중복하는 주석
  코드의 내용을 중복하여 설명

• 오해할 여지가 있는 주석
  코드보다도 읽기도 어려운 주석에 담긴 '살짝 잘못된 정보' 의 주석

• 의무적으로 다는 주석
  모든 함수에 Jacadocs를 달거나 모든 변수에 주석을 달아햐 한다는 규칙

• 이력을 기록하는 주석

  
  코드이력은 소스 코드 관리 시스템으로도 충분

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

• 무서운 잡음
  때로는 Javadocs도 잡음이다

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

• 위치를 표시하는 주석

• 닫는 괄호에 다는 주석

• 공로를 돌리거나 저자를 표시하는 주석
  소스 코드 관리 시스템을 이용하자

• 주석으로 처리한 코드
  주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다. 소스 코드 관리 시스템이 우리를 대신해 코드를 기억해준다.

• HTML 주석

• 전역 정보
  코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하지 마라

• 너무 많은 정보

• 모호한 관계

• 함수 헤더

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

오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요

코드로 의도를 충분히 표현하지 못해 실패를 만회하기 위해 다는 주석이라는 문구가 이번 장을 읽는 내내 와닿는 문장이다. 협업하는 사람이나 후에 내 코드를 볼 사람들이 코드를 이해하기 쉽도록 가이드 한다고 생각하며 작성한 한 줄의 주석이 도리어 코드를 더 읽기 힘들게 만들수 있다는 생각을 가지고 주석을 달고 싶은 유혹이 들때마다 작성한 코드를 다시한번 다듬어서 코드만 읽어도 충분하게 만들어야겠다.

궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.

나쁜 주석의 예들 중 '함수 헤더' 라고 정리한 것의 예제 코드가 있었다면 더 좋았을 것 같다.