Clean Naming

Clean Naming을 알아보기에 앞서 Clean Code란 무엇일까?

 

Clean Code란?

이해하기 쉽고, 변경하기 쉬운 Code.

사람이 읽고 이해하기 쉽고, 명확한 한가지 역할을 하며, 이 역할을 의미있게 표현하고,

중복이 없고 테스트 케이스가 존재하는 Code 이다.

 

 

 

Clean Naming은 가독성 향상에 가장 중요한 요소이다.

 

개발의 대부분은 코드를 이해하고 수정하는 행위이다. 만약 그게 수백 라인의 코드라면 크게 어려운 일이 아닐 것이다. 그러나 수십, 수백만 라인의 코드를 읽고 이해하고 수정하는 것은 매우 어려운 일이다. 그렇기에 Clean Naming에 대한 작은 투자는 장기적으로는 팀의 개발 생산성 향상에 크게 기여가 될 수 있는 부분이다.

 

 

SW의 주요 요소들은 모두 아래와 같이 Clean Name이 필요하다.

 

---

 

★ Clean Naming의 대원칙 ★

「 모든 이름은 반드시 그 의미가 모두에게 명확해야 한다. 」

 

 

▶ Clean Naming의 원칙
· Function, Class 역할이 명확하면 Naming도 명확해진다.
· 불필요한 정보/반복은 제거해야 한다.
· 줄임말(약어)를 사용하지 않아야 한다.
· 규칙과 일관성은 중요하다.
· 동료와 상의해야 한다.

 

하나씩 자세히 알아보자.

 

≫ Function, Class 역할이 명확하면 Naming도 명확해진다.

  - Clean Function, Class의 제 1원칙은 명확히 한 가지 역할을 하는 것이다.

  - 역할이 많으면 이름도 명확하지 않게 된다. (ex. User, GeneralUtil ···)

 

≫ 불필요한 정보/반복은 제거해야 한다.

  - 이름은 이해가능한 최소한의 정보를 담고 있어야 한다. (너무 짧지도, 장황하지도 않아야 함)

  - 불필요한 정보 (ex. UserData, processFunc() ···)

 

≫ 줄임말(약어)를 사용하지 않아야 한다.

  - 줄임말은 가독성을 심각하게 저하시킨다.

  - 누구나 이해할 수 있는 줄임말은 존재하지 않는다.

  - 줄임말의 예 (temp, prdt, acc() → temperature, product, accelerateSpeed() ···)

 

≫ 규칙과 일관성은 중요하다.

  - 언어별, 조직별 Naming Convention을 일관성 있게 지켜야 한다.

  - 일관성은 코드를 이해하고 수정하는 노력을 감소시킨다.

  - 일관성 없는 Naming은 가독성을 저하시킨다.

 

≫ 동료와 상의해야 한다.

  - 모든 원칙을 적용해도 좋은 이름이 떠오르지 않을 때

  - 내가 명명한 이름에 대한 확신이 없을 때

   → 이럴때는 동료와 함께하는 리뷰, 브레인스토밍이 가장 좋은 방법이다.

 

 

---

 

"  Variable 을 위한 Clean Naming "

 

변수의 type에 따라 이름을 어떻게 작성해야 할까?

 

위 Naming의 실제 사례를 보자

Naming의 사례

 

그러나, 이러한 이름도 충분히 좋지만 상황에 따라 부가적인 정보를 제시한다면 더 명확히 변수를 표현할 수 있다.

부가적인 정보를 포함한 변수명 예시

 

그럼 Clean Variable Naming의 Bad Smell에 대해서도 알아보자

Bad Smell의 예시

 

앞서 본 각 변수에 대한 Bad Smell의 사례를 보자

변수에 따른 Bad Smell 사례

 

 

---

 

"  Method 를 위한 Clean Naming "

 

· Method의 이름은 의도와 기능을 명확하게 표현해야 한다.

· Method의 이름은 어떤 동작(동사)을 무엇을 대상(명사)으로 할 것인지로 '동사+명사'로 조합하여 표현한다.

 

Method Type에 따라 이름을 어떻게 작성해야 할까?

 

위 작성법에 따른 Naming에 부가적인 정보를 함께한 사례를 보자

부가적인 정보를 추가한 메소드명 예시

 

그럼 Clean Variable Naming의 Bad Smell에 대해서도 알아보자

Method Bad Smell의 예시

Method에 따른 Bad Smell 예시

 

 

---

 

"  Class 를 위한 Clean Naming "

 

- 클래스에 의해 생성되는 객체를 의미있게 설명해야 한다.

- '명사 또는 명사구'를 사용하고, 동사는 사용하지 않는다.

 

Class Name의 사례를 보자

가운데의 이름이 가장 적절한 사례

 

▶ Clean Class Naming의 원칙
  - 구체적이고 명확한 이름을 사용해라.
  - Convention을 준수하는 일관성 있는 이름을 사용해라.
  - 보편 언어를 활용해라.

 

≫ 구체적이고 명확한 이름을 사용해라.

좋은 클래스 이름의 예시

 

≫ Convention을 준수하는 일관성 있는 이름을 사용해라.

특정 개념에 대해 일관성을 유지하는 예시

  - 조직내부에서 특정 개념에 대한 용어를 정의하고 일관성이 있게 사용해야 한다.

  - 보편적인 기술 용어를 활용해야한다. (ex. Factory, Builder, Obsever, Controller)

 

≫ 보편 언어를 활용해라.

도메인 전문가가 사용한 개념을 엔지니어는 도메인 모델의 설계/구현 클래스에도 동일하게 사용해야 함

  - 도메인 전문가, SW 아키텍트, 개발자의 언어를 모두 통일해야 한다.

  - 기준은 도메인 전문가들이 사용하는 언어가 되어야 한다.

  - 이 언어는 모든 커뮤니케이션, 설계문서, 실제 코드까지 통일되어야 한다.

 

 

---

 

Coding Rule

SW 개발 가이드라인 및 규칙의 모음

 

Coding Rule의 종류

 

 

Coding Rule의 준수여부 확인

 

 

---

 

코드프레소 Java 웹 개발 체험단 활동 중 'SW 유지보수성 향상을 위한 Clean Code' 이러닝 강의를 듣고 작성하였습니다 :)
코드프레소 URL: https://www.codepresso.kr/

프리미엄 IT 교육 서비스 - 코드프레소