Community

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

← Go back
TIL 4장. 주석
#clean_code
2년 전
534

오늘 TIL 3줄 요약

  • 의도나 의미를 명료하게 밝히는 주석

  • 코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문

  • 함수의 이름은 정보를 담고, 짧고 한 가지만 수행하는 함수는 가독성을 높이게 되면 주석을 사용할 필요 없음

TIL (Today I Learned) 날짜

2022.04.29

오늘 읽은 범위

4장. 주석

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

  • 짧고 한 가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋다.

  • 코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하지 마라.

  • 주석이 필요하지 않도록 코드를 개선하는 편이 더 좋다.

  • 있으나 마나한 주석은 지나친 참견이라 개발자가 주석을 무시하는 습관에 빠진다.

  • 모든 변수에 주석을 달아야 한다는 규칙은 어리석기 그지없다. 이런 주석은 코드를 복잡하게 만들며, 거짓말을 퍼뜨리고, 혼돈과 무질서를 초래한다.

  • 주석이 코드보다 더 많은 정보를 제공하지 못한다. 실제로 코드보다 부정확해 독자가 함수를 대충 이해하고 넘어가게 만든다. 엔진 후드를 열어볼 필요가 없다며 고객에게 아양 떠는 중고차 판매원과 비슷하다.

  • 코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문

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

  • 정보를 제공하는 주석은, 가능하다면, 함수 이름에 정보를 담는 편이 좋다.

  • 주석이 코드보다 더 많은 정보를 제공하지 못한다.

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

코드를 왜 이렇게 짰는지에 대한 의도만 조금씩 달아야겠다.

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

  • javadocs

오늘 읽은 다른사람의 TIL