Community

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

← Go back
TIL.Assignment #05: 4장. 주석
#clean_code
2년 전
412

TIL (Today I Learned)

오늘 읽은 범위

4장. 주석 나쁜 주석

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

  • 나쁜주석

    • 주절거리는 주석

    • 같은 이야기를 중복하는 주석

    • 오해의 여지가 있는 주석

    • 있으나 마나 한 주석

    • 의무적으로 다는 주석

    • 이력을 기록하는 주석

    • 있으나 마나 한 주석(당연한)

    • 위치를 표시하는 주석

    • 닫는 괄호 뒤의 주석

    • 공로를 돌리거나 저자를 표시하는 주석

    • 주석으로 처리한 코드

      • 주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다.

    • HTML 주석

    • 전역 정보

      • 주석을 달아야 한다면 근처에 있는 코드만 기술하라

    • 너무 많은 정보

    • 모호한 관계

      • 주석과 주석이 설명하는 코드는 둘 사이 관계가 명확해야 한다.

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

  • 애초에 이름을 잘 짓거나 짧거나 알아보기 쉽게 작성된 코드 등 주석이 필요 없는 상황이 베스트다. 앞장의 내용과 이어진다.

  • git 과같은 코드관리 시스템이 거의 필수인 요즘 보수가 필요한 주석으로 이를 관리한다던가

  • 오해를 일으키는 등 없느니만 못한 주석 등 전체적인 플러스와 마이너스를 보아야 한다는 이야기같다.

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