Community

개발자 99% 커뮤니티에서 수다 떨어요!

← Go back
TIL 3장 함수
#clean_code
2년 전
482


TIL (Today I Learned)

2022.2.23

오늘 읽은 범위

3장. 함수

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

  • 작게 만들어라 !

블록과 들여쓰기

1. if, else, whie 문 등에 들어가는 블록은 한 줄이어야 한다.

2. 중첩 구조가 생길만큼 함수가 켜져서는 안 된다. 함수에서 들여쓰기 수준은 1단이나 2단을 넘어서면 안 된다.

  • 한 가지만 해라 !

함수를 만드는 이유는 큰 개념을 (다시 말해, 함수 이름을) 다음 추상화 수준에서 여러 단계로 나눠 수행하기 위해서이다.

함수 당 추상화 수준은 하나로 !

switch 문은 다형적 객체를 생성하는 코드안에서만 사용한다. (?)

(이렇게 상속 관계로 숨긴 후에는 절대로 다른 코드에 노출하지 않는다.)

  • 서술적인 이름을 사용하라 !

코드를 읽으면서 짐작했던 기능을 각 루틴이 그대로 수행하다면 깨끗한 코드라 불러도 되겠다.

함수가 작고 단순할수록 서술적인 이름을 고르기도 쉬워진다.

길고 서술적인 이름이 짧고 어려운 이름보다 좋다. 길고 서술적인 이름이 길고 서술적인 주석보다 좋다. 함수 이름을 정할 때는 여러 단어가 쉽게 읽히는 명명법을 사용한다. 그런 다음, 여러 단어를 사용해 함수 기능을 잘 표현하는 이름을 선택한다.

예) includeSetupAndTeardownPages, includeSetupPages, includeSuiteSetupPage

  • 함수 인수 : 이상적인 인수 개수는 0개다.

    함수에 인수 1개를 넘기는 이유는 첫째, 질문은 던지는 경우이고, 다른 하는 인수를 뭔가로 변환해 결과를 반환하는 경우다. 드물게 사용하지만 유용한 단항 함수 형식은 이벤트다. 프로그램은 함수 호출을 이벤트로 해석해 입력 인수로 시스템 상태를 바꾼다.

  • 인수 객체

인수가 2-3개 필요하다면 일부를 독자적인 클래스 변수로 선언할 수 있는지 살펴본다.

  • 동사와 키워드

단항 함수는 함수와 인수가 동사 / 명사 쌍을 이뤄야 한다. writeField(name)

함수 이름에 인수 이름을 넣는다. 예를 들어, assertEquals 보다 assertExpectedEqualsActual(expected, actual)이 더 좋다. 그러면 인수 순서를 기억할 필요가 없어진다.

  • 부수 효과를 일으키지 마라 !

함수 이름이 정의하는 기능 이외에 다른 기능을 수행하면 혼란을 일으킨다.

  • 출력 인수

객체 지향 프로그래밍이 나오기 전에는 출력 인수가 불가피한 경우도 있었다. 하지만 객체 지향 언어에서는 출력 인수를 사용할 필요가 거의 없다. 출력 인수로 사용하라고 설계한 변수가 바로 this 이기 때문이다.

appendFooter(s) -> report.appendFooter()

일반적으로 출력 인수는 피해야 한다. 함수에서 상태를 변경해야 한다면 함수가 속한 객체 상태를 변경하는 방식을 택한다.

  • 명령과 조회를 분리하다 !

함수는 뭔가를 수행하거나 뭔가에 답하거나 둘 중 하나만 해야 한다. 둘 다 하면 안 된다. 객체 상태를 변경하거나 아니면 객체 정보를 반환하거나 둘 중 하나다.

명령과 조회를 분리해 혼란을 애초에 뿌리뽑아야 한다.

if (attributeExists("username")) {

setAttribute("username", "unclebob");

}

  • 오류 코드보다 예외를 사용하라

오류 코드 대신 예외를 사용하면 오류 처리 코드가 원래 코드에서 분리되므로 코드가 깔끔해진다.

try / catch 블록은 원래 추하다. 코드 구조에 혼란을 일으키며, 정상 동작과 오류 처리 동작을 뒤섞는다. 그러므로 try / catch 블록을 별도 함수로 뽑아내는 편이 좋다.

  • 반복하지 마라

중복을 제거할 목적으로 관계형 데이터베이스에 정규 형식을 만들었다.

객체 지향 프로그래밍은 코드를 부모 클래스로 몰아 중복을 없앤다.

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

함수를 만들고 이름 짓는 것에 대해 많은 것을 배울 수 있었다. 코딩하다 함수를 아무 생각 없이 즉흥적으로 만들게 되는데 한 번 더 생각해서 가독성 좋은 코드를 만들 수 있을 것 같다.

너무 좋은 내용은 맞는데 100% 이해를 못 해서 실제로 적용해 보는 건 쉬울 것 같지 않다. 하나씩 적용해 나가면서 더 생각해 봐야 조금 더 이해할 수 있겠다.

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

중복을 제거할 목적으로 관계형 데이터베이스에 정규 형식을 만들었다.

객체 지향 프로그래밍은 코드를 부모 클래스로 몰아 중복을 없앤다.

switch 문은 다형적 객체를 생성하는 코드안에서만 사용한다. (?)