[💻 Programming] Clean Code - 의미있는 이름을 써라

출처:클린 코드 Clean Code - 애자일 소프트웨어 장인 정신  / 로버트 C. 마틴

 

안녕하세요 Foma 👟 입니다!

저번 글엔 깨끗한 코드가 무엇인지에 대해 다뤄보았는데요.

 

이번엔 좀 더 구체적으로 깨끗한 코드를 작성하기 위한 첫번째 규칙 "의미있는 이름" 에 대해서 정리해보도록 하겠습니다.

---

의도를 분명히 밝혀라

 

나쁜 예 ❌

 

만약 아래와 같은 함수가 있다면 뭘 의미하는지 알 수가 없다.

 

func abc(a:String,b:String) -> String {
    return a+b
}

 

좋은 예 👍🏻

 

위와 같은 역할을 함수이지만 아래처럼 작성하면 확실히 성과 이름을 받아서 풀네임을 만드는 것이구나 라고 알 수 있다.

 

func makeFullName(firstName:String,lastName:String) -> String {
    let fullName = firstName + lastName
    return fullName
}

---

잘못된 정보를 피해라

 

나쁜 예 ❌

 

분명 딕셔너리 형태인데 이름은 어레이라고 되어있다.

 

let nameArray = ["foma":"포마","gran":"그랜","안":"영훈"]

 

좋은 예 👍🏻

 

let nameDictionary = ["foma":"포마","gran":"그랜","안":"영훈"]

---

의미있게 구분해라

 

나쁜 예 ❌

 

아래와 같이 작성하면 서로의 차이를 알 수가 없다.

 

class PersonData {...}

class PersongObject {...}

class PersongModel {...}

 

좋은 예 👍🏻

 

class Owner {...}

class Employee {...}

class Customer {...}

---

발음하기 쉬운 이름을 사용해라

 

나쁜 예 ❌

 

이 함수에서 잘못된 부분을 찾고 알려주려면 뭐라고 발음해야 할지 모른다.

 

func gostmnaa() {...}

 

좋은 예 👍🏻

 

func getOldestManNameAndAge() {...}

---

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

 

나쁜 예 ❌

 

let length = 5

 

좋은 예 👍🏻

 

let LENGTH_OF_SQUARE = 5

---

클래스 이름은 명사로 지어라

 

나쁜 예 ❌

 

class GetPerson {...}

 

좋은 예 👍🏻

 

class Person {...}

---

메서드 이름은 동사로 지어라

 

나쁜 예 ❌

 

func fullName() {...}

 

좋은 예 👍🏻

 

func makeFullName() {...}

---

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

 

만약 어떤 값를 받아오는 메서드를 쓴다면

 

나쁜 예 ❌

 

func getWomanCount() {...}

func retrieveAnimalCount() {...}

func fetchManCount() {...}

 

좋은 예 👍🏻

 

func getWomanCount() {...}

func getAnimalCount() {...}

func getManCount() {...}