본문 바로가기
행위 돌아보기/독후감상문

[개발자의 글쓰기] 2장 개발 시간을 줄여주는 이름 짓기와 주석 쓰기

by simplify-len 2020. 12. 13.

중요한 단어는 앞에 쓴다.

// 안좋은 예
int totalVisitor

int totalRegister
int totalBuyer
int totalSalesOfThisMonth
int maxSizeOfWindow
int numberOfTotalVIP
int visitorTotal
int registerTotal
int buyerTotal
int salesOfthisMonthTotal
int windowSizeMax
int vipCount

함수 이름 짓는 순서

함수는 시스템이 할 일을 나타내는 것이지 사용자가 할 일을 나타내는 것이 아니다. 따라서 함수의 주체, 즉, 주어도 없앤다.

좋은 이름의 기준, SMART

좋은 이름이 가진 5가지 특징

  • easy to Search 검색하기 쉽고
  • easy to Mix 조합하기 쉽고
  • easy to Agree 수긍하기 쉽고
  • easy to Remember 기억하기 쉽고
  • easy to Type 입력하기 쉽고

코드는 의미를 나타내고, 주석은 의도를 나타내야 한다.

댓글