Community

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

← Go back
TIL 2022-02-26
#clean_code
2년 전
453


TIL (Today I Learned)

2022.02.26

오늘 읽은 범위

4장. 주석

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

  • 내가 이렇듯 주석을 무시하는 이유가 무엇이냐고? 거짓말을 하니까. 항상도 아니고 고의도 아니지만 너무 자주 거짓말을 하니까. 주석은 오래될수록 코드에서 멀어진다. 오래될수록 완전히 그릇될 가능성도 커진다. 이유는 단순하다. 프로그래머들이 주석을 유지하고 보수하기란 현실적으로 불가능하니까. ( p,68 )

  • 부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다. 부정확한 주석은 독자를 현혹하고 오도한다. 부정확한 주석은 결코 이뤄지지 않을 기대를 심어준다. 더 이상 지킬 필요가 없는 규칙이나 지켜서는 안 되는 규칙을 명시한다. 진실은 한곳에만 존재한다. 바로 코드다. 코드만이 자기가 하는 일을 진실되게 말한다. 코드만이 정확한 정보를 제공하는 유일한 출처다. 그러므로 우리는 (간혹 필요할지라도) 주석을 가능한 줄이도록 꾸준히 노력해야 한다. ( p.69 )

  • 자신에게 이렇게 말한다. “이런! 주석을 달아야겠다!” 아니다! 코드를 정리해야 한다! 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다. 자신이 저지른 난장판을 주석으로 설명 하려 애쓰는 대신에 그 난장판을 깨끗이 치우는 데 시간을 보내라!( p.69 )

  • 중요성을 강조하는 주석 자칫 대수롭지 않다고 여겨질 뭔가의 중요성을 강조하기 위해서도 주석을 사용 한다. ( p.75 )

  • 특별한 이유 없이 의무감으로 혹은 프로세스에서 하라고 하니까 마지못해 주석을 단다면 전적으로 시간낭비다. 주석을 달기로 결정했다면 충분한 시간을 들여 최고의 주석을 달도록 노력한다. ( p,76 )

  • TODO 주석 때로는 ‘앞으로 할 일’을 //TODO 주석으로 남겨두면 편하다. ( p,74 )

  • 배너는 눈에 띄며 주의를 환기한다. 그러므로 반드시 필요할 때만, 아주 드물게 사용하는 편이 좋다. 배너를 남용하면 독자가 흔한 잡음으로 여겨 무시한다. ( p.85 )

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

  • 주석은 오래되면 오래될수록 코드를 어지럽힐 가능성이 있지만 중요하거나 다음에 해야 할것을 메모하는 정도로 쓰면서 함수를 좀더 깔끔하게 만들어야 되겟다고 생각이듭니다..

  • 주석을 적게!

  • 함수를 깔끔하게!

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