TIL 04. 주석

오늘 TIL 3줄 요약

  • 많은 경우 주석으로 달려는 설명을 새로운 코드(즉, 리팩토링해라)로 대체하는 것으로 충분한 경우가 많다. (70p)
  • 닫는 괄호에 주석을 달아야겠다는 생각이 들면 함수를 줄이려는 시도를 하자.(85p)
  • 의도 표현은 주석이 아닌 코드로! (법적 표현 같이 알기 힘든 요소 제외하고는..?)

TIL (Today I Learned) 날짜

2022.04.29

오늘 읽은 범위

4장. 주석

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

  • 좋은 주석
    1. 법적인 주석
    2. 정보를 제공하는 주석
    3. 의도를 설명하는 주석
    4. 의미를 명료하게 밝히는 주석
    5. 결과를 경고하는 주석 (ex - 실행 시간이 오래 걸린다는 주석)
    6. TODO 주석 -> But! 이 TODO를 나쁜 코드를 남겨둘 용도로 사용하는 것은 금물이다. 작성할 코드를 미루지 말 것!
    7. 중요성을 강조하는 주석
  • 나쁜 주석
    1. 독자를 배려하지 않는 주석( = 작성자만 의미를 해석할 수 있는 주석)
    2. 같은 이야기를 중복하는 주석
    3. 의무적으로 다는 주석 (ex - 모든 함수에 Javadocs를 넣으라는 규칙)
    4. 닫는 괄호에 다는 주석
    5. 주석으로 처리한 코드 (형상 관리는 폼으로 존재하지 않는다.)

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

  • 에라토스테네스의 체 예시를 앞서 얘기한 항목 별로 적용 여부를 직접 판단해 보는게 저자(로버트.C.마틴)가 전달하려는 내용을 갈무리한다. 코딩 테스트를 위해 알고리즘 문제를 풀어봤다면 한 번쯤은 에라토스테네스의 체와 관련된 문제를 풀어봤을 것이다. 그래서 더더욱 90p의 예시에 해당하는 책의 내용을 직접 찾아보고, 체감해 보는 것이 꼭 필수 절차라 생각했다.