Community

개발자 99% 커뮤니티에서 수다 떨어요!

← Go back
[TIL] 4. 주석
#clean_code
2년 전
517
1

TIL (Today I Learned)

2022.02.24

오늘 읽은 범위

4장. 주석

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

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

-> 지저분한 모듈을 설명하기 위해 주석을 작성한다고 그 지저분한 모듈이 좋아지진 않는다. 난장판을 주석으로 설명하는 시간에 지저분한 난장판을 깨끗이 치우는데 시간을 보내라

 

코드로 의도를 표현하라!

-> 코드만으로 의도를 설명하기 어려운 경우가 있어 주석으로 설명하는 경우가 있다. 하지만 이 주석의 설명을 바탕으로 함수를 구현하고 표현하는 방법도 있다.

 

물론 좋은 주석도 있다.

-> 물론 불문율은 좋은 주석이란 주석을 다지 않아도 되는 방법을 찾은 주석이다. 그 외에는

법적인 주석, 추상화의 기본적인 정보를 설명해주는 주석, 저자의 의도를 명료하게 설명해주는 주석, 결과를 경고하는 주석, 해당 코드의 앞으로 필요한 개발 방향과 현재 구현하지 않은 이유를 설명하는 주석 등이 있다. 

 

그 외 대부분의 나쁜 주석들은 의무적으로 달거나, 굳이 필요없거나 뭐라 설명하는지 해석하기 난해한 주석들이 많다.

 

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

주석은 쉰들러 리스트가 아니다

 주석은 필요악이다. 유대인을 구제하기 위한 '쉰들러 리스트' 처럼 주석을 통해 이미 엉망진창인 코드를 살리지 못한다. 우리 회사는 주석을 남기지 않도록 코드를 읽고 이해할 수 있도록 코드를 구현하고자 하는 문화가 있다. 처음 회사 코드를 보고 주석이 하나도 없어 불편함을 느꼈던 경우도 있지만, 그만큼 코드 작성과 리뷰에 시간을 들여 클린한 코드를 작성하고자 했던것이 아닐까.

그래서 결론은 주석이 필요없는 코드를 구현하자


1 comment