📘클린코드 (2022.01.24) - 의미 있는 이름 (1)

DAY 4

오늘 읽은 범위

2장 의미 있는 이름 ~32p

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

• 의도를 분명히 밝혀라

  • 변수나 함수 그리고 클래스의 이름은 항상 이들의 존재 이유, 수행 기능, 사용 방법을 모두 답할 수 있어야한다.
  • 주석으로 설명이 필요하다면 이는 의도를 분명히 드러내지 못했다는 의미이다.

• 그릇된 정보를 피하라

  • 그릇된 단서는 코드의 의미를 흐린다.
  • 나름대로 널리 쓰이는 의미가 있는 단어를 다른 의미로 사용해도 안된다.
    (hp라는 널리 알려진 유닉스 플랫폼이 있는데 직사각형의 빗변(hypotenuse)의 약어로 hp가 적당하다 생각해 사용하면 안된다는 의미이다.)
  • 일관성이 떨어지는 표기법을 사용해선 안된다.
  • I와 1, O과 0을 조심하자!

• 의미 있게 구분하라

  • 컴파일러와 인터프리터를 통과하고 싶단 생각에 충돌되는 이름 중 하나의 철자를 살짝 바꾸는 행위는 금지이다.
  • 연속적인 숫자를 덧붙인 이름을 사용하면 안된다.
    • a1,a2,a3...aN은 그릇된 정보도, 의미도 제공하지 않는 이름이다. (자주 사용하는데 고쳐야겠다..)
  • 불용어를 추가하는 방식도 적절하지 못하다.
    • Product라는 클래스가 있을 때, 다른 클래스를 ProductInfo, ProductData라 부르면 Product와 ProductInfo를 구분할 수 있는가? Info, Data등은 a, an, the와 마찬가지로 의미가 불분명한 불용어이다.(추가로 Variable, Amount, Object, String등이 있다..)
      읽는 사람이 차이를 알도록 이름을 지어야 한다.!
    • 그렇다고 a, the를 사용하지 말라는 것이 아니다. 요는 zork라는 이름이 있다는 이유로 theZork라는 이름을 지어선 안된다는 것이다.

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

  • 발음하기 어려운 이름은 토론하기도 어렵다. 프로그래밍은 사회 활동이기 때문에 발음하기 쉬운 이름은 중요하다.
    (무분별한 약어사용은 발음을 어렵게 만든다. 영단어가 아니기 때문에 의미도 설명해야한다.)

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

  • 문자 하나를 사용하는 이름과 상수는 쉽게 찾을 수 없다.
    • e는 가장 많이 쓰이는 문자이다. 그런데 만약 e라는 변수가 있다면 코드에서 어떻게 검색할 수 있을까? 정말 어려울 것이다..
  • 긴 이름은 짧은 이름보다 좋고, 검색하기 쉬운 이름이 상수보다 좋다.

• 자신의 기억력을 자랑하지 마라

  • 독자가 코드를 읽으며 변수 이름을 자신이 아는 이름으로 변환해야 한다면, 즉 통상적이지 않은 이름을 사용했다면 이는 바람직 하지 못한 변수 이름이다.
  • 똑똑한 프로그래머는 자신만이 기억하는 변수를 사용할 수 있지만 전문적인 프로그래머는 명료함이 최고라는 사실을 알고있기 때문에 남들이 이해하는 코드를 내놓는다.

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

• 불용어를 조심하라는 부분이 매우 인상 깊었다. 코드를 짤때 User라는 변수가 사용중이면 UserAccount를 만들어 사용하는 경험은 매번 있었던 것 같다. 내가 짠 코드였기 때문에 내겐 구분에 문제가 없었지만 만약 다른사람이 코드를 봤다면 나에게 화를 낼 수도 있다는 것을 깨달았다..

• 나는 영어를 잘 하지 못하기 때문에 본능..?적으로 긴 단어로 이름을 짓는것 꺼려했었다. 대학교에서 처음 코드를 봤을때에도 변수나 함수명이 길면 어려운 코드인가 싶어 겁부터 났던거 같다. 그래서 짧고 명료한 이름이 최고라고 생각했지만 배울수록 짧고 명료한 이름이란 것은 없는것을 깨달았다.. 알고는 있었지만 피해왔던 긴 명명법을 이제는 열심히 고민해서 지어야겠다.

• 나중에 아이를 낳으면 작명소가 아니라 프로그래머에게 데려가서 이름을 지어달라하는게 더 좋을 것 같다.. 그만큼 책에선 내가 파악하지 못한 부분까지 세세히 이름짓는 방법을 제시하고 있다.

✏ 소감 3줄 요약

• 이름은 존재 이유, 수행 기능, 사용 방법을 모두 유추할 수 있어야 한다.
• 나만 아는 이름은 어디에서도 쓸 수 없다. 독자를 생각한 이름을 만들어야한다.
• 짧은 이름보다 긴 이름이 좋고, 검색하기 쉬운 이름이 좋다!