TIL (Today I Learned)

2022.02.24

오늘 읽은 범위

4장. 주석

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

• 표현력이 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다. 자신이 저지른 난장판을 주석으로 설명하려 애쓰는 대신에 그 난장판을 깨끗이 치우는데 시간을 보내라!

• 좋은 주석

  • todo주석

  • 중요성 강조

  • 결과를 경고

• 나쁜 주석

  • 위치 표시 : 반드시 필요할 때만, 드물게 사용하기

  • 닫는 괄호 주석 : 차라리 함수를 줄이자

  • 주석처리코드 : 그냥 삭제하자!

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

• 나쁜 주석들 중에 내가 찔리는 부분을 일단 정리해보았다.... 아직 그렇게 어려운 코드를 짜는 프로그래머가 아니기에 저정도만 있지만 나중에 더 길고 복잡한 코드를 짜게 된다면 분명히 또다른 실수를 할테니 지금 자주 하는것부터 하나하나 고쳐나가도록 해야겠다.

• 또한 좋은 주석들 중에 지금 내가 쉽게 따라할만한 사항을 정리해보았다. 코드 정리하면서 저런 부분을 적용해봐야지!

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

• N/A