Community

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

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

오늘 TIL 3줄 요약

  • 나쁜 코드에 주석을 달지 말고, 코드를 다시 작성해라

  • 주석 대신에 코드로 의도를 표현해라.

  • 나중에 개선할 사항이 있다면 TODO 주석을 사용하라

TIL (Today I Learned) 날짜

2022. 04. 28

오늘 읽은 범위

4장. 주석

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

주석 대신에 코드로 의도를 표현해라

주석을 단다는 것은 양해를 구해야 하는 것이지 요구 사항이 아니다. 좋은 코드는 대부분 그 자체로 문서가 된다. 주석으로 달려는 설명을 함수나 변수로 만들어 표현하자.

좋은 주석

  • 법적인 주석(저작권 및 소유권 정보)

  • 정보를 제공하는 주석(정규식의 반환값 등)

  • TODO주석(하지만 주기적으로 점검해 불필요한 TODO주석을 제거해야 한다.)

나쁜 주석

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

: 함수나 클래스의 설명을 단 주석은 이들을 대충 이해하고 넘어가게 만든다.

이력을 기록하는 주석

: 이력을 주석으로 달기보다 버전 관리 시스템을 통해 확인하자.

위치를 표시하는 주석

: 적절한 들여쓰기와 포맷을 통해 시각적인 구조를 부여하자.

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

주석이 있으면 확실히 코드의 흐름을 이해하는데 방해가 된다. 코드와 주석이 다른 역할을 하는 것을 명확히 인지하고 있고, 이 때문에 코드를 읽다가 주석을 발견하게 되면 주석을 읽느라 코드의 흐름에서 빠져나오게 된다. 이게 잦다면 문제가 될 것이다. 되도록이면 코드를 통해 의도를 표현할 수 있도록 만들자!

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

현업에서 많이 쓰일지 모르겠지만, CSS 파일에서 하나의 큰 HTML 요소(예를 들어 navbar, main, footer 등)들을 구분하기 위해 주석을 통해 위치를 표시해서 사용했었던 적이 있다. CSS 파일이 길게 늘어져 있다면 주석을 통해 위치를 분리해주는 것도 나쁜 주석인 걸까?

오늘 읽은 다른사람의 TIL

2 comments