TIL (Today I Learned)

2022.02.25

오늘 읽은 범위

4장. 주석

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

• 주석은 '순수하게 선하지' 못하다. (p.68)

  • 프로그래밍 언어 자체가 표현력이 풍부하다면, 아니 우리에게 프로그래밍 언어를 치밀하게 사용해 의도를 표현할 능력이 있다면, 주석은 거의 필요하지 않으리라. 아니, 전혀 필요하지 않으리라.

  • 우리는 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다.

  • 주석은 언제나 실패를 의미한다.

• 주석은 오래될수록 코드 예시에서 멀어진다. (p.68)

  • 프로그래머들이 주석을 유지하고 보수하기란 현실적으로 불가능하니까.

• 코드는 변화하고 진화한다. (p.68)

  • 불행하게도 주석이 언제나 코드를 따라가지는 않는다. 아니, 따라가지 못한다.

• 자신에게 말한다. "이런! 주석을 달아야겠다!" 아니다! 코드를 정리해야 한다! (p.69)

• 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다. (p.69)

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

• 이번엔 '주석'이라는 도구에 대해 의견을 얘기한 부분을 읽어보게 되었다. 하지만, 여태까지 클린 코드를 작성하기 위해선, 코딩을 하기 위해 쓰이는 요소를 어떻게 작성해야 한다고, 설명하고 있었다면, 결론적으로 클린 코드를 작성하려면, 주석을 쓰지 않길 권장하는 듯 하다.

• 여태껏 나에게 있어 주석이란 도구는 작성한 코드의 의도를 다시 되새기고자 하였거나, 모르는 코드를 인용하여 사용했을 때, 혹은 다른 사람이 작성한 코드를 보고 이해하는 데 도움을 주고 하는 의도와 같은 수많은 문제를 미리 예방하고자 쓰였다. 하지만, 이러한 이유는 결국 코드로 의도를 제대로 펼치지 못하는 내 실수를 회피하고자 하는 것이라 볼 수 있다는 것이 가슴에 와닿았다.

• 앞서 의미있는 이름을 짓는 법에 대해, 전체적 그리고 구체적으론 함수의 경우에서 어떻게 작성해야 하는지 배워볼 수 있었다. 오늘의 내용에서도 공통적이었다면, 내용이 간략하고 명확하다면, 그 내용에 쓰인 함수명과 변수명 만으로도 누구나 읽고 이해할 수 있는 코드를 작성할 수 있다는 것이다. 결국 클린 코드의 목표 중 하나는 프로그래밍 언어에 대한 이해가 부족하더라도 쉽게 읽을 수 있는 코드를 작성하는 것이 아닌가라는 생각을 해보게 되었다.

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

• 쉰들러 리스트

• Javadocs