Clean Code 3장

Clean code 3장

함수

1. 작게 만들어라.

• 함수는 작을수록 좋다. 이 책에는 20줄도 길다고 말한다. 현재 개발중인 프로젝트에서 중요 기능 함수가 160줄 정도이다…
• if문, else문, while 문에 들어가는 블록은 한줄이어야 한다. 그 한줄은 다시 대개 함수를 호출한다.

2. 한가지만 해라.

• 함수는 한가지를 해야 한다. 그 한가지를 잘해야 한다. 그 한 가지만을 해야한다.

3. 함수 당 추상화 수준은 하나로.

• 한 함수 내에 추상화 수준을 섞으면 코드를 읽는 사람이 헷갈린다.
• 내려가기 규칙: 위에서 아래로 이야기처럼 읽히는 방식 -> 위에서 아래로 내려갈수록 함수 추상화 수준이 한단계씩 내려간다.

4. Switch 문

• 읽고 이해하기 어려웠던 부분이다.
• switch 문을 추상 팩토리에 숨기면 된다는 뜻이다. 추상 클래스를 만들어 함수를 생성하여 인터페이스를 통해 호출되는 과정이다.

5. 서술적인 이름을 사용하라.

• 함수 이름을 함수가 하는 일을 더 잘 표현할 수 있게 만들어라.
• 이름을 붙일때는 일관성도 중요하다.

6. 함수 인수

• 이상적인 인수는 0개이다. 인수는 적을수록 좋다.
• 단항 형식 : 인수에 질문을 던지는 경우, 인수를 뭔가로 변환해 결과를 반환하는 경우, 두 경우를 제외하고 사용은 가급적 피한다.
• 플래그 인수: 함수로 bool 값을 넘기는 형식, 사용하지 말자
• 이항함수: 인수가 무조건 두개여야 하는 경우를 제외하고 단항함수로 바꾸고자 노력을 해야한다.
• 삼항함수: 삼항함수는 볼때마다 이해하기 여렵다. 그러므로 정말로 필요할때만 쓰자
• 인수 객체: 객체를 생성하여 인수를 줄이는 방식도 좋다. 객체를 생성하는것 자체가 개념을 설명하는것과 같기 때문이다.
• 동사와 키워드: 단항 함수는 함수와 인수가 동사/ 명사쌍을 이뤄야 한다. ex) writeField(name), 다항 함수들은 함수 이름에 인수들의 키워드를 넣어주면 순서를 기억안해도 되므로 좋다.

7. 부수 효과를 일으키지 말아라.

• 함수 이름으로 알수 있는 기능들 이외의 작은 기능이라도 포함되지 않아야 한다.
• 예를들어 비밀번호 확인이라는 함수에서 세션을 초기화 하는 기능을 넣지 않는것이 좋다. 예상할수 없기 때문에.

8. 명령과 조회를 분리하라.

• 함수는 뭔가를 수행하거나 뭔가에 답하거나 둘중 하나만 해야한다.

9. 오류코드 보다는 예외를 사용하자.

• 어떠한 함수에서 오류 코드를 리턴하는것보다 예외 처리를 통해 처리 하는것이 깔끔하다.
• 하지만 함수에 그냥 넣으면 코드의 혼란이 야기 될수 있기때문에 try/catch문을 따로 함수로 빼는것이 좋다. ->오류 처리도 한가지 작업에 속한다.

10. 반복하지 말아라.

• 반복되는 알고리즘을 줄인다. 알고리즘이 바뀌면 모든 코드를 수정해야 한다.

11. 구조적 프로그래밍

• 작은 함수에서 return,break,continue를 여러차례 사용해도되지만 goto 문은 자제 하는것이 좋다.

12. 함수를 짜는방법

• 처음에는 길고 복잡한 함수를 작성
• 하지만 그 코드들을 모두 테스트 하는 단위 테스트 케이스 생성 하기
• 코드를 다듬고 함수를 만들고, 이름을 바꾸고, 중복을 제거하고 , 메소드를 줄이고 순서를 바꾸며 단위테스트를 모두 통과하도록 만들어준다.

3장을 읽고 함수를 짜는 방법에 대해서 배우게 되었다. 현재 진행하는 프로젝트의 함수들도 현재 중복된 알고리즘이 많고 이름도 규칙이 없으며 한 함수는 많은 일들을 하고 다듬어 지지 않은 상태이다. 따라서 나는 이제 3장에서 배운 내용들을 내가 진행하는 프로젝트 함수에 적용시켜 함수를 잘 만들어 봐야겠다.

맨위로👆