오늘 TIL 3줄 요약

• 소프트웨어에서 이름은 어디에나 쓰이므로, 이름을 잘 지어놔야 여러모로 편하다.

• 좋은 이름을 선택하려면 설명 능력이 뛰어나야 하고, 문화적인 배경이 같아야 한다.

• 이름은 코드가 잘 읽히는데에 큰 역할을 하므로, 규칙을 적용해 코드를 개선시켜 나가야 한다.

TIL (Today I Learned) 날짜

2022.04.22

오늘 읽은 범위

2장.의미있는 이름

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

이름을 잘 짓는 간단한 규칙들을 정리해본다.

1. 의도를 분명히 밝혀라 :

   
   존재 이유는? 수행 기능은? 사용 방법은? 에 대한 의도가 드러나는 이름을 사용한다.

2. 그릇된 정보를 피하라 :
   널리 쓰이고 있는 의미가 있는 단어를 다른 의미로 사용하면 안된다. (hp, aix, sco)
   서로 흡사한 이름을 사용하지 않도록 한다.
   유사한 개념은 유사한 표기법을 사용한다.

3. 의미 있게 구분하라 :
   연속된 숫자를 덧붙이거나 불용어(Info, Data ...)를 추가하는 방식은 적절하지 못하다.

4. 발음하기 쉬운 이름을 사용하라 :
   발음하기 어려운 이름은 토론하기도 어렵다. “젠 야 무다 함즈 값이 이상한데요?”

5. 검색하기 쉬운 이름을 사용하라 :
   문자 하나를 사용하거나 상수값은 텍스트 검색이 쉽게 되지 않는다. (e, 7)

6. 인코딩을 피하라 :
   인코딩한 이름은 발음하기 어려우며 오타가 생기기도 쉽다.
   타입은 바뀌어도 이름은 바뀌지 않는다. (phoneString)
   멤버변수 접두어는 더이상 필요하지 않다. (m_name)
   (예외) 인터페이스와 구현 클래스 ⇒ ShapeFactoryImpl

7. 자신의 기억력을 자랑하지 마라 :
   전문가 프로그래머는 명료함이 최고다.
   기억할 생각하지 말고 명료하게 이름을 지어놓자.

8. 이름 품사 :
   클래스 이름과 객체 이름은 명사나 명사구가 적합하다. (Customer, Account)
   메서드 이름은 동사나 동사구가 적합하다. (postPayment, deletePage)

9. 기발한 이름은 피하라 :
   명료한 이름을 선택해라. (HolyHandGrenade 보다는 DeleteItems)

10. 개념과 단위 :
    한 개념에 한 단어를 사용해라.
    일관성 있는 단어가 혼란을 가져오지 않는다.
    말장난을 하지 말고 한 단어를 두가지 목적으로 사용하지 말아라.
    (add로 모든걸 표현하기 보다는 add, insert 로 구분해서 사용한다.)

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

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

13. 의미있는 맥락을 추가하라 :
    스스로 의미가 불분명한 이름을 써야만 한다면 접두어를 붙여서 사용한다.
    (addrState - 주소의 State)
    일반적으로는 짧은 이름이 긴 이름보다 좋다
    ⇒ 이름에 불필요한 맥락을 추가 하지 않도록 주의하며, 필요할때만 접두어를 사용한다.

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

변수에 내가 생각하는 모든 의도를 전부 넣게되면 너무 길어질 수도 있을것 같은데, 적절히 표현할 수 있는 방법을 꾸준히 연습해 나가야 할 것 같다. 그럼에도 불구하고 좋은 이름은 프로그래밍에서 매우 중요한 기초이니, 위 규칙을 항상 유념하도록 해야겠다.

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

“문제 영역에서 가져온 이름을 사용하라" 에 해당하는 실제 사례가 생각나지 않아 잘 와닿지가 않는다.

오늘 읽은 다른사람의 TIL