의미있는 이름 정하기

깨끗한 코드란?

코드가 문장처럼 읽히고, 어떤 일을 하는지 명확하게 알 수 있는 코드.

이를 위해서는 함수, 변수, 클래스 등등의 이름을 잘 지어야 함.

• 의도가 분명한 이름을 사용

var a //a자체는 아무 의미 없으므로 사용 불가
var fileAgeInDays //이런식으로 의미가 분명한 이름을 사용

그릇된 정보를 피해라

• 약어 사용 지양
  • hp같은 약어 쓰지말고 그냥 풀어서 사용
• List같은 특수한 의미는 분명하게 사용
  • 실제 List로 구현하지 않은 것에 List같은 특수한 의미가 있는 이름 사용 금지
    • groups, ~s로 사용
• 서로 흡사한 이름 사용 금지

불용어 사용 금지

Product, ProductInfo, ProductData 같은 다른 사람이 보았을때 어떤 차이가 있는지 알기 힘든 이름 사용 X

Info, Data는 의미가 불분명함.

ex) Customer과 CustomerObject / getActiveAccount(), getActiveAccounts(), getActiveAccountInfo()

 

클래스 이름 

클래스나 객체 이름은 명사나 명사구가 적합

ex) Customer, Account, Adress...

 

함수 이름

동사나 동사구가 적합

ex) posetPayment, deletePage...

접근자나 변경자, 조건자는 앞에 get,set ,is를 붙임

ex) getNumber, isPay, setValue...

 

참고: 클린코드 애자일 소프트웨어 장인 정신(로버트 C.마틴)