Community

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

← Go back
# TIL [클린코드 4장] 주석
#clean_code
2년 전
532

오늘 TIL 3줄 요약

좋은 주석 만들기

  • 의미 명료

  • 의미없는 주석

  • 주석 스타일의 변화

TIL (Today I Learned) 날짜

2022.04.29

오늘 읽은 범위

4장. 주석

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

  • 주석 작성 스타일은 변한다.

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

필자는 주석을 선호하는 편이다.

주석이 모두 나쁜 것이라고 소개하지만 그건 아닌 것 같다.

코드로 확인할 수 있도록 작성하는 것은 굉장히 이상적인 이야기다.

남들이 이해할 수 있게 함수와 변수 이름을 만들고, 코드를 작성할 수 있을까?? 이 정도 수준이라면 주석은 필요 없을 것 같다.

주석 스타일에 대해서는 본인만의 방식을 지정하는 것이 좋은 것 같다.

최대한 명확하며 필수적인 내용만 적는다.

그리고 주석을 작성한다면 최대한 "이해 가능하게" 작성하는 것이 좋다.

여러 주석을 보면 "이게 한국말인가" 싶은 주석이 있다.

코드를 봐도 주석을 봐도 굉장히 치명적이다.

함수, 이름 작성 중요하다. 하지만 내용 전달도 중요하다.

주석으로 설명하고자 했지만, 설명이 이해가 안되는 경우 답답하다..

상황이 필요하다면 코드를 이렇게 작성하게 된 배경을,

함수가 길다면 이 함수가 나타내는 내용을,

복잡하다면 자세한 설명을 추가한다.

개인적인 팁을 추가한다.

  • 네이버 맞춤법 검사기 사용

  • 새로운 용어가 나온다면 용어 설명부터

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

없음

오늘 읽은 다른사람의 TIL

없음