TIL (Today I Learned)

// 2022.02.20

오늘 읽은 범위

// 2장. 의미 있는 이름

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

1. 의도를 분명히 밝혀라 (p.22)

   • 변수, 함수, 클래스 이름의 존재 이유는? 수행 기능은 사용 방법은?

   • 따로 주석이 필요하다면 의도를 분명히 드러내지 못했다는 말이다.

2. 그릇된 정보를 피하라 (p.24 ~ 25)

   • 널리 쓰이는 의미가 있는 단어를 다른 의미로 사용해서는 안된다.

   • 서로 흡사한 이름을 사용하지 않도록 주의한다.

   • 이름으로 그릇된 정보를 제공 하지 않도록 주의 해라 (알파벳 소문자 L과 대문자 O는 각각 숫자 1과 0으로 착각될 가능성이 높다)

3. 의미 있게 구분하라 (p.25 ~ 27)

   • 연속된 숫자를 덧붙이거나 불용어를 추가하는 방식은 적절하지 못하다.

   • 변수나 함수명의 작명에 주의 하라. 읽는 사람이 차이를 알도록 이름을 지어라.

4. 발음하기 쉬운 이름을 사용하라 (p.27)

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

   • 긴 이름이 짧은 이름보다 좋다. 검색하기 쉬운이름이 상수보다 좋다.

6. 인코딩을 피하라

7. 자신의 기억력을 자랑하지 마라 (p.31 ~ 32)

   • 문자 하나만 사용하는 변수 이름은 문제가 있다. *루프의 반복 변수는 예외

   • 똑똑한 프로그래머와 전문가 프로그래머의 차이는 명료함이 최고라는 것을 이해하고 있다는것, 남들이 이해하는 코드를 내놓는다.

8. 말잔안을 하지 마라

   • 한 단어를 두 가지 목적으로 사용하지 마라. (add나 insert는 비슷해 보이지만 사용에 따라선 이해가 달라진다)

9. 코드 개선 노력과 마찬가지로 이름 역시 개선하려는 노력을 중단해서는 안된다 (p.38)

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

• 변수명을 작성하는 부분에서 공감이 되었다. 코드길이가 너무 길어져 번잡해 보이는것을 피하기 위하여 변수명을 짧게 하려고 노력하였던 적이 있다. 하지만, 내가 이해를 하고 있더라도 동료가 읽었을때, 혹은 시간이 지나고 보수를 위해 다시 읽었을때 이해에 시간이 드는 모순이 발생하여 이름이 길더라도 한눈에 이해가 되는 이름을 짓는것이 중요하다고 느꼈다. 전 장에서도 언급되었듯이 나중은 오지 않는다. 작성시 부터 고려하여 작성하자.

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

• 불용어에 대한 개념이 아직 잡혀있지 않아 학습이 필요하다

• [의미 있는 맥락을 추가하라]등의 부분의 코드의 이해 부족으로 인해 완전한 이해가 되지 않았다 추가 학습이 필요.