Typefully

Don't write comments!

Avatar

Share

 • 

3 years ago

 • 

View on X

"Code is Liability"라는 말에 공감을 하지만, 코드의 "why"를 설명하는 코멘트 만큼은 예외를 두고 미래의 나를 위해 구구절절 주석을 남기곤 했는데.. 최근 CodeAesthetic 채널에서 "Don't Write Comments" 영상을 보고 한번 더 생각. 어그로성 제목을 달고 설득력 있는 몇 가지 이유를 나누는데:
"Programs are meant to be read by humans and only incidentally for computers to execute." - from SICP 애초에 코드는 사람이 읽으려고 만든 장치다. 코드 위 주석은 마치 2개의 다른 언어로 소통을 하려는 것과 비슷하다. 비효율적이고 자칫 의미가 잘못 해석될 여지도 있다.
단순히 변수 이름 잘 사용해 가독성을 높이는 것이 아니라 언어가 주어진 기능를 잘 활용해서 주석을 줄일 수 도 있다. 예로 주석으로 사용법을 설명하는 것이 아니라 type을 활용해 암묵적으로 전달 할 수도 있다. 이러한 type 정보는 컴파일러도 "이해" 할 수 있어 버그도 잡아 줄 수도 있다.
더 좋은 코드를 작성할 생각을 하지 않고 구구절절 긴 주석으로 넘긴적이 많았던거 같다. 반성!
Avatar

Daniel Lee

@dylayed

개발이야기를 좋아합니다. Software Engineer at @Google/@Firebase