클린코드 2장 의미있는 이름

cyr·2021년 11월 15일
0

title: 클린코드 2장 의미있는 이름
date: "2021-11-11T07:00:00.169Z"
template: "post"
draft: false
slug: "클린코드 2장 의미있는 이름"
category: "Book"
tags:

  • "Book"
    description: "클린코드 2장 의미있는 이름"

클린코드 2장 의미있는 이름

의도가 드러난 이름을 써라

대표적으로 문제가 되는 경우

  1. 자료형을 변수명으로 사용하는 경우(List, class, Dict)
  2. 지나치게 축약하려고 하는 경우(day => d)

그릇된 정보를 피해라

예를 들어, 여러 계정을 그룹으로 뭈을 때, 실제 List가 아니라면, accountList라 명명하지 마라.
또한 서로 흡사한 이름을 사용하지 않도록 주의해야한다. 잘못된 변수를 아무렇지 않게 사용하게 될 수 있다.
알파벳 l과 숫자 1, 알파벳 O와 숫자 0과 같은 경우도 마찬가지이다.

의미 있게 구분하라

불용어를 추가한 이름을 사용하지마라.
예를 들어, a0, a1, a2, a3 ... ... 과 같이 변수에 숫자만 붙인경우에는 의도가 전혀 드러나지 않는다.

또한 ProductData와, ProductInfo 같은 변수를 동시에 사용하면 의미구분을 할 수 없다.
결론적으로 읽는 사람이 차이를 알 수 있도록 이름을 지어야 한다.

검색하기 쉬운 이름을 사용하라

지나치게 축약하면 검색했을 때 겹치는 이름이많을 수 있다.
의미를 내포하게 적절히 긴 이름을 사용하는 것이 좋다.

클래스 이름

명사나 명사구를 사용
예: Customer, WikiPage, Account, AddressParser
틀린 예 : Manager, Processor, Data, Info

메서드 이름

동사나 동사구 사용
예: getName, setName, istPosted

한 개념에 한단어를 사용하라

예를 들면 controller, manager를 혼용해서 쓰지말아야 한다.

profile
개발

0개의 댓글