[Clean Code] TIL - Day 06

Clean Code TIL Day 06

Day 06

🔖 오늘 읽은 범위 :  3장 함수 (p.40~p.54)

---

😃 책에서 기억하고 싶은 내용

• 함수를 만드는 첫째 규칙은 '작게!'다. 함수를 만드는 둘째 규칙은 '더 작게!'다.(p.42)
• if 문/else 문/while 문 등에 들어가는 블록은 한 줄이어야 한다는 의미다. 대게 거기서 함수를 호출한다. 그러면 바깥을 감싸는 함수가 작아질 뿐 아니라, 블록 안에서 호출하는 함수 이름을 적절히 짓는다면, 코드를 이해하기도 쉬워진다.(p.44)
• 함수는 한 가지를 해야 한다. 그 한 가지를 잘해야 한다. 그 한 가지만을 해야 한다.(p.44)
• 함수가 '한 가지'만을 하는지 판단하는 방법이 하나 더 있다. 단순히 다른 표현이 아니라 의미 있는 이름으로 다른 함수를 추출할 수 있다면 그 함수는 여러 작업을 하는 셈이다.(p.45)
• 함수가 확실히 '한 가지' 작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일해야 한다.(p.45)
• 코드는 위에서 아래로 이야기처럼 읽혀야 좋다. 한 함수 다음에는 추상화 수준이 한 단계 낮은 함수가 온다. 즉, 위에서 아래로 프로그램을 읽으면 함수 추상화 수준이 한 번에 한 단계씩 낮아진다.(p.46)
• 이름이 길어도 괜찮다. 겁먹을 필요 없다. 길고 서술적인 이름이 짧고 어려운 이름보다 좋다. 길고 서술적인 이름이 길고 서술적인 주석보다 좋다. 함수 이름을 정할 때는 여러 단어가 쉽게 읽히는 명명법을 사용한다. 그런 다음, 여러 단어를 사용해 함수 기능을 잘 표현하는 이름을 선택한다.(p.49)
• 이름을 붙일 때는 일관성이 있어야 한다. 모듈 내에서 함수 이름은 같은 문구, 명사, 동사를 사용한다. includeSetupAndTeardownPages, includeSetupPages, includeSutieSetupPage, includeSetupPage 등이 좋은 예다. 문제가 비슷하면 이야기를 순차적으로 풀어가도 쉬워진다. 방금 열거한 함수를 살펴보라. 당장 이런 질문이 떠오르리라. "includeTeardownPages, includeSuiteTeardownPage, includeTeardownPage도 있나요?" 당연하다. '짐작하는 대로'다.(p.50)
• 함수에서 이상적인 인수 개수는 0개(무항)다. 다음은 1개(단항)고, 다음은 2개(이항)다. 3개(삼항)는 가능한 피하는 편이 좋다. 4개 이상(다항)은 특별한 이유가 필요하다. 특별한 이유가 있어도 사용하면 안 된다.(p.50)
• 플래그 인수는 추하다. 함수로 부울 값을 넘기는 관례는 정말로 끔찍하다. 왜냐고? 함수가 한꺼번에 여러 가지를 처리한다고 대놓고 공표하는 셈이니까!(p.51)
• 함수 이름에 키워드를 추가하는 형식이다. 즉, 함수 이름에 인수 이름을 넣는다. 예를 들어, assertEquals 보다 assertExpetedEqualsActual (expected, actual)이 더 좋다. 그러면 인수 순서를 기억할 필요가 없어진다.

🤔 오늘 읽은 소감과 떠오르는 생각

오늘 읽은 부분은 정말 도움이 많이 됐다.

매번 코드를 짤 때 함수를 어디까지 나눠야 할지, 이름은 어떻게 지어야 하는 건지 평소에 정말 물어볼 사람도 없고 궁금했던 부분이다.

함수 이름을 지을 때는 이름이 너무 길어져서 일부러 짧게 축약시킨 적이 몇 번 있었는데 내용 중에서 '이름이 길어도 괜찮다. 겁먹을 필요 없다. 길고 서술적인 이름이 짧고 어려운 이름보다 좋다.'라는 부분을 보고 확신을 느끼게 되었고, 함수는 한 가지 기능만 하게 끔 최대한 나눠 주는 것이 좋다고 알게 되었고 이 한 가지의 기준은 추상화 수준이 하나라고 내용에서 확실히 알려줘서 감이 잡힌 것 같다. 

이런 내용들을 빨리 코드를 직접 짜면서 적용해 보고 싶은 마음에 설렌다.

오늘 이 부분을 읽고 어제보다 조금이나마 나은 내가 된 것 같아서 만족한다.

🔎 궁금한 내용이 있거나, 잘 이해되지 않는 내용

추상화라는 단어가 자주 등장했는데, 이 추상화라는 단어가 뭔지 알아봤다.

추상화란 구체적인 것을 감추고 보고 싶어 하는 전체적인 특성을 드러내는 것이다. 소프트웨어 개발에서의 추상화란 인터페이스에 의존하고, 구체적인 구현에는 의존하지 않는 것을 말하는 것으로, 함수를 기본적인 추상화 방법으로 사용한다. 함수의 이름을 통해서 구체적으로 하는 일을 추상화시켜서 나타낸다는 뜻이다. 예를 들어, "printf()"가 파일에 대한 출력을 담당 한다는 의미로, 구체적인 출력에 관련된 내용을 추상적으로 대표해서 표현하는 것과 같다.

https://m.blog.naver.com/PostView.naver?isHttpsRedirect=true&blogId=knix008&logNo=220700047637

소감 3줄 요약

• 함수는 한 가지 일만 최대한 작게!
• 길고 서술적인 이름이 짧고 어려운 이름보다 좋다.
• 함수당 추상화 수준은 하나로.