생각정리/노마드코더

노마드 개발자 북클럽 (클린코드: 주석)

제로스크랩 2024. 2. 1. 22:53


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

주석은 기껏해야 필요악이다. 코드를 잘 짜면 주석은 거의 필요 없다
부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다.
주석은 함수나 변수로 표현할 수 있다면 달지 않는 것이 원칙이다.

읽고난 후의 생각.

주석에 대한 나의 생각은 연차별로 다르다.
1~3년차정도에는 주석을 쓰지 않아서 많은 문제가 발생했었는데 5년차 이후부터는 오히려 주석을 줄이고 있다.
 
그래서 요즘은 크게 3단계로 나눠서 코딩을한다.
 
1단계는 생각이 나는대로 코딩을하고 주석을 다는 것
2단계는 적어둔 주석을 보고 코드를 줄이는 것
3단계는 함수명이나 변수명으로 코드를 설명하도록 명칭을 수정하는 것.
 
물론 급하면 3단계는 종종 생략한다.
하지만 이 단계별 습관이 몸에 익혀질수록 전체 흐름이 기억에 더 잘 남게되고 결론적으로 더 큰 그림을 그릴 수 있게 되는 것 같다.
 
어쩌다보니 이 책의 저자가 중요시 하는 것을 나도모르게 잘 지키고 있던 것 같아 다행이라 생각한다.
 

 

궁금한 내용 또는 이해되지 않는 내용 메모.

  • 없음

오늘 읽은 소감은? 떠오르는 생각

728x90
반응형