클린 코드 #8일차

TIL (Today I Learned)

 

• 2022.02.25

 

📕 오늘 읽은 범위

 

• 4장. 주석

 

🙂 책에서 기억하고 싶은 내용

 

• 코드만이 자기가 하는 일을 진실되 게 말한다. 코드만이 정확한 정보를 제공하는 유일한 출처다. 그러므로 우리는 (간혹 필요할지라도) 주석을 가능한 줄이도록 꾸준히 노력해야 한다. (p.69)

 

• 짧은 함수는 긴 설명이 필요 없다. 짧고 한 가지만 수행하며 이름을 잘 붙인 함수 가 주석으로 헤더를 추가한 함수보다 훨씬 좋다. (p.89)

 

🤔 오늘 읽은 소감은?

 

   주석은 대체로 코드를 읽는 사람에게 정보를 전달하는 목표로 작성된다.
이번 장에서는 필요한 주석과 불필요한 주석을 구분하고 줄이는 방법을 소개하고 있다.

   과거에 주석은 수정된 부분을 표시하거나 버전 관리 명시용으로도 많이 쓰였지만, 요즘엔 소스 관리 툴에서 누가 언제 소스를 수정했는지를 알려주기 때문에 그에 관련된 주석은 불필요하다. 코드를 중복해서 설명하는 주석도 불필요하다. 부정확한 주석은 오히려 혼동을 줄 수 있다.

   코드를 작성할 때 작성자가 본인이 설계한 알고리즘 대로 스크립트를 짜다보면 어느 부분에서 주석을 달 때 그 메소드/함수에서 찾을 수 없는 내용들이 가끔 들어가기도 하는데 이런 부분들이 그런 작성자의 설계 히스토리를 모르는 사람이 전달 받았을 때 이해하기 힘들 수 있다는 것이다.

   최대한 잘 짜여진 코드를 통해서 전달하고자 하는 바를 전해야하고 그마저도 힘들 때 주석의 도움을 받아야지, 주석 인플레이션으로 정작 중요한 메세지를 놓치지 않도록 코드를 정리하고 고민하는 습관이 중요할 것이다.