📘클린코드 (2022.01.25) - 의미 있는 이름 (2)

DAY 5

오늘 읽은 범위

2장 의미 있는 이름 ~38p

😃 책에서 기억하고 싶은 내용을 써보세요.

• 클래스 이름

  • 클래스 이름과 객체의 이름은 명사나 명사구가 적합하다. 동사는 사용하지 않는다.
    • 좋은 예 : Customer, WikiPage, Account...
    • 나쁜 예 : Manager, Processor, Data, Info... (무슨? 에 대답을 못함)

• 메서드 이름

  • 메서드 이름은 동사나 동사구가 적합하다.
  • 접근자, 변경자, 조건자는 javabean의 표준에 따라 각각 앞에 get, set, is를 붙힌다.
    • 좋은 예 : postPayment, deletePage, savePage...

• 기발한 이름은 피하라

  • 특정 문화에서만 사용하는 농담이나 유행어는 피하는 편이 좋다.

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

  • 추상적인 개념하나에 단어 하나를 선택해 이를 고수해라.
    • DeviceManager와 ProtocolController의 차이를 이해할 수 있는가?
    • 이름이 다르면 독자는 당연히 다른 클래스에 타입도 다르다 생각한다.

• 말장난을 하지마라

  • 한 단어를 두 가지 목적으로 사용하지 마라.
  • 앞서 "한 개념에 한 단어를 사용하라"는 규칙을 따랐더니, 여러 클래스에 모두 add라는 메서드가 생겼다.
    만약 이들이 모두 같은 반환값 출력하는 의미(예를 들어 a+b)를 갖는다면 상관 없다.
    하지만 어떤 클래스에선 덧셈, 어떤 클래스에선 배열 추가를 의미한다면 이것은 문제가 된다.

• 해법 영역에서 가져온 이름을 사용하라

  • 기술 개념에는 기술 이름이 가장 적합한 선택이다.

• 문제 영역에서 가져온 이름을 사용하라

  • 적절한 '프로그래머 용어'가 없다면 문제 영역에서 이름을 가져온다.
  • 우수한 프로그래머와 설계자는 해법 영역과 문제 영역을 구분할 줄 알아야한다.

• 의미 있는 맥락을 추가하라

  • 스스로 의미가 분명한 이름은 있지만 대다수는 그렇지 못하다. 때문에 맥락이 중요하다. 접두어는 마지막 수단이다.
    • street, city, state, zipcode라는 변수가 있을 때 변수를 훑어보면 주소라는 사실을 알 수 있다.
    • 하지만 state 변수 하나만 사용할 때 주소의 일부라는 의미인지 알 수 있을까?
    • addrStreet, addrCity, addrState처럼 접두어를 붙히면 더 맥락이 분명해 질 것이다.

• 불필요한 맥락을 없애라

  • 만약 증권거래소(stock exchange)애플리케이션을 짠다고 모든 클래스 이름을 SEUser, SETrainer... 처럼 SE를 붙힐 필요는 없다. 이는 매우 낭비이다!
  • 일반적으로 의미가 분명할 경우 짧은 이름이 긴 이름보다 좋다.
  • 이름에 불필요한 맥락을 부여하지 말자.

🙄오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요

• 직접적으로 변수는 어떤식으로, 클래스는 어떤식으로 명명하라는 기준이 나와서 참고가 많이 됐다. 책에 나온 기준을 모두 암기할때까지는 코드를 짤때 항상 책을 옆에 놓고 작업해야겠다.

• 기발한 이름은 피하며 한 개념엔 한단어를 사용하고.. 한 단어를 여러 목적으로 사용하면 안되면서.. 의미 있는 맥락을 추가하고... 불필요한 맥락을 삭제... 참 이름짓는게 쉽지 않다. 많이 연습해보는게 답인 것 같다.

🔎 궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.

• 해법영역과 문제영역을 구분할 줄 알아야 한다는데.. 둘의 개념이 잘 정립되지 않는다.

✏ 소감 3줄 요약

• 클래스나 객체 이름은 명사나 명사구, 메서드 이름은 동사나 동사구를 사용하자.
• 한 개념에 한 단어만 사용하고 의미 있는 맥락을 잘 이용하자.
• 다른 개발자의 반대, 두려움, 게으름 등에 부딪혀도 코드를 개선하려는 노력을 중단해서는 안된다.