파카

클린코드, 주석 본문

일지/독서

클린코드, 주석

Anphaca 2022. 2. 4. 15:40
사실상 주석은 기껏해야 필요악이다

 

주석은 기껏해야 필요악이다..

클린 코드에 나오는 문장이다.

 

 어렴풋이 생각했던 개념을 이번 장을 읽으면서 정리할 수 있었다.

이렇게 책을 읽으면서 좋은 인사이트를 얻을 수 있다는 것에 감사하면서 책을 읽어 나갈 수 있었다. 

 

[주석! 습관적으로 쓰지말자]

 간혹 주석이 다른 이들과의 협업을 위한 배려라고 생각했던 적이 있다.

근데 나도 생각해보면 주석을 읽으면서 “이게 뭔소리야 ?” 하고 툴툴 거렸던 기억이 있다. 그에 대한 명확한 답이 책에 있었다.

 

“코드는 변화하고 진화한다” 코드는 변화하고 진화했지만 주석은 그대로였기 때문이다.

주석에 대해 인사이트를 주어서 너무 좋은 시간이었다.

 

 의미없는 주석은 오히려 가독성을 해치고 불편함을 초래한다.

주석을 달아놓아야하지 하면서 만들기보다 코드의 품질을 올리기 위한 생각을 위주로 하도록 더 노력해야 겠다는

생각을 가지게 되어 책을 읽으면서 너무 좋았다.

 

 그러면서도 좋은 주석에 대해서도 다시 한 번 생각을 가지게 해주는 부분도 좋았다.

좋은 주석파트를 보고 맞는 상황인지는 모르겠지만 어느정도 공감이 되었다.

 

오늘의 소감 요약

- 습관적으로 주석을 달지말자, 주석은 기껏해야 필요악이다.

- 코드는 변화하고 진화한다.
 : 주석을 같이 유지보수하기란 어렵기 때문에 코드를 업그레이드하자

- 코드의 품질을 높이는데 집중하자. 

 

++ 

그나저나 리액트는 또 언제 정리하지.. ㅠㅠ

'일지 > 독서' 카테고리의 다른 글

클린코드, 객체와 자료구조  (0) 2022.02.16
클린코드, 형식 맞추기  (0) 2022.02.10
클린코드, 함수  (0) 2022.01.29
클린코드, 의미있는 이름  (0) 2022.01.26
클린코드 1장, 깨끗한코드  (0) 2022.01.21
Comments