주석 쓰지 마!

"주석은 많이, 상세히 적을 수록 좋습니다."

 

"잘하는 사람의 코드에는 주석이 많아요."

강사 님이 수업 내내 주석의 중요성을 설파하셨다.
주석이 많을수록 좋은 코드라고.
또한 모든 수식에는 괄호를 넣을 것을 권했다.

 

int a, b

a=4;

b=a>2;

 

대략 위와 비슷한 내용의 코드에서 a>2가 아니라 (a>2)를 써야 한단다.
그 이유는 다음과 같다고 한다.

"컴파일러에 따라 ##$@#$ 결과가 바뀔 수 있습니다."

---

나는 무엇 하나 동의하기가 어렵다.
주석을 많이 쓰는 것도,

수식마다 괄호를 쓰는 것도.

주석은 주석일 뿐이다. 많기는커녕 적을수록 좋다고 생각한다.

 

"아니, 주석이 없으면 코드를 어떻게 독해하라구욧!"

나는 되묻고 싶다.

 

코드가 모호하다고 주석을 붙이면 어떻게 해!

 

a, b 이런 식으로 코드를 만드는 작자들이 있으니 주석 타령이 나오게 되는 거 아닐까?

코드는 그 자체로 완결성을 가져야 한다.
주석 달기 이전에 변수 선언을 제대로 해야 한다.
변수명과 함수명을 잘 짓는다면 주석이 과연 필요할까?

(물론 나도 적절한 주석을 만나는 것은 너무 반갑다)

또한 로직을 명료하게 짜면 주석을 읽을 필요가 없다.

 

const coffee = {
  itemName: 'coffee',
  itemPrice: 10000
}

function isDiscountItem (item) {
  const ITEM_DISCOUNT_MIN_PRICE = 1000
  
  return item.itemPrice >= ITEM_DISCOUNT_MIN_PRICE
}

const isCoffeeDiscounted = isDiscountItem(coffee)
console.log(isCoffeeDiscounted)

 

변수명을 보고 어떤 값이 들어있을지 추측이 돼야 한다.
이렇게만 해도 코드의 가독성이 올라간다.
에러가 나도 최소한 타입 에러는 파악이 되겠지.

물론 나는 작명 잘 못하지만 ㅜ.ㅜ

이러한 모든 노력을 마친 후에도 정말로 주석이 필요하다면 써야겠지.
근데 과제니까 주석 써야겠네.
주석이 있어야 채점하기 쉽겠구나.