TIL (Today I Learned)

2022.02.26

오늘 읽은 범위

4장. 주석

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

• 나쁜 코드에 주석을 달지 마라. 새로 짜라 - 브라이언 W. 커니핸, P.J. 플라우거 (p. 68)

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

• 학원 프로젝트 당시, 내 코드를 다른 팀원들이 보고 재사용 할 수 있도록 구구절절 사용방법부터 이 줄의 코드는 무슨 의미인지 주석을 한줄한줄 달았던 적이 있다. 그 당시엔 이 정도면 누구든지 코드를 보고 읽고 가져가서 사용할 수 있겠거니 하고 생각했었는데 지금 생각해보니 정말 잘못된 코드였던 것 같다. 이 코드들은 주석이 없으면 이해할 수 없습니다를 스스로 홍보하는 꼴이었다. 또 가끔은 주석이 차지하는 줄이 너무 많아 위에 무슨 코드였지? 변수명이 무엇이었지? 하고 찾으러 올라간 적도 있는데 내가 사용했던 주석은 정말 코드 이해의 방해꾼이었던 것 같다. 주석을 달 생각 이전에 최대한 코드를 어떻게 누가봐도 이해할 수 있고, 잘 굴러가도록 짜는 것에 좀 더 초점을 맞춰야겠다.

궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.