Community

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

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


TIL (Today I Learned)

// 2022.02.25

오늘 읽은 범위

// 4장. 주석

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

  • 코드만이 자기가 하는 일을 진실되게 말한다. 코드만이 정확한 정보를 제공하는 유일한 출처다. 그러므로 우리는 주석을 가능한 줄이도록 꾸준히 노력해야 한다. (p.69)

  • 주석이 올바른지 검증하기 쉽지 않다. 이것이 의미를 명료히 밝히는 주석이 필요한 이유인 동시에 주석이 위험한 이유이기도 하다. 그러므로 더 나은 방법이 없는지 고민하고 정확히 달도록 각별히 주의한다. (p.73)

  • 닫는 괄호에 주석을 달아야겠다는 생각이 든다면 대신에 함수를 줄이려 시도하자. (p.85)

  • 주석을 다는 목적은 코드만으로 설명이 부족해서다. 주석 자체가 다시 설명을 요구하니 안타깝기 그지없다. (p.89)

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

  • 오늘은 4장 주석에 관한 내용에 대해 읽었다. 코드를 작성할 때, 이 함수가 어떤 기능을 하는지 이 코드가 어떤 의미를 갖고 있는지 주석에 달았었다. 코드는 한줄인데 주석을 두줄이상 적었던 적도 있었다. 과거의 나를 후회하고 있다. 이 책을 읽고, 주석을 달아야겠다는 생각보다 함수를 줄이든지 딱 알아볼 수 있게 코드를 짜는게 좋은 코드라는 것을 깨달았다.

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