3장. 함수

내용

• 어떤 프로그램이든 가장 기본적인 단위가 함수다.
• 함수를 만드는 첫째 규칙은 ‘작게!’다. 함수를 만드는 둘째 규칙은 ‘더 작게!’다.
• Sparkle은 모든 함수가 2줄, 3줄, 4줄 정도였다. 각 함수가 너무도 명백했다. 각 함수가 이야기 하나를 표현했다. 각 함수가 너무도 멋지게 다음 무대를 준비했다. 바로 이것이 답이다!
• if 문/else 문/while 문 등에 들어가는 블록은 한 줄이어야 한다. 대게 거기서 함수를 호출한다. 그러면 바깥을 감싸는 함수가 작아질 뿐 아니라, 블록 안에서 호출하는 함수 이름을 적절히 짓는다면, 코드를 이해하기도 쉬워진다.
• 중첩 구조가 생길만큼 함수가 커져서는 안 된다. 함수에서 들여쓰기 수준은 1단이나 2단을 넘어서면 안 된다. 당연한 말이지만, 그래야 함수는 읽고 이해하기 쉬워진다.
• 함수는 한 가지를 해야 한다. 그 한 가지를 잘 해야 한다. 그 한 가지만을 해야 한다.
• 지정된 함수 이름 아래에서 추상화 수준이 하나인 단계만 수행한다면 그 함수는 한 가지 작업만 한다. 우리가 함수를 만드는 이유는 큰 개념을 다음 추상화 수준에서 여러 단계로 나눠 수행하기 위해서가 아니던가.
• 단순히 다른 표현이 아니라 의미 있는 이름으로 다른 함수를 추출할 수 있다면 그 함수는 여러 작업을 하는 셈이다.
• 한 가지 작업만 하는 함수는 자연스럽게 섹션으로 나누기 어렵다.
• 함수가 확실히 ‘한 가지’ 작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일해야 한다.
• 한 함수 내에 추상화 수준을 섞으면 코드를 읽는 사람이 헷갈린다. 특정 표현이 근본 개념인지 아니면 세부사항인지 구분하기 어려운 탓이다. 근본 개념과 세부사항을 뒤섞기 시작하면, 깨어진 창문처럼 사람들이 함수에 세부사항을 점점 더 추가한다.
• 한 함수 다음에는 추상화 수준이 한 단계 낮은 함수가 온다.
• 핵심은 짧으면서도 ‘한 가지’만 하는 함수다.
• 각 함수는 다음 함수를 소개한다. 또한 각 함수는 일정한 추상화 수준을 유지한다.
• switch 문은 작게 만들기 어렵다. 또한 ‘한 가지’ 작업만 하는 switch 문도 만들기 어렵다. 본질적으로 switch 문은 N가지를 처리한다.
• 나는 switch 문을 단 한 번만 참아준다. 다형적 객체를 생성하는 코드 안에서다. 이렇게 상속 관계로 숨긴 후엔ㄴ 절대로 다른 코드에 노출하지 않는다.
• 서술적인 이름을 사용하라!
• 함수가 작고 단순할수록 서술적인 이름을 고르기도 쉬워진다.
• 길고 서술적인 이름이 짧고 어려운 이름보다 좋다. 길고 서술적인 이름이 길고 서술적인 주석보다 좋다.
• 이름을 정하느라 시간을 들여도 괜찮다.
• 서술적인 이름을 사용하면 개발자 머릿속에서도 설계가 뚜렷해지므로 코드르 개선하기 쉬워진다. 좋은 이름을 고른 후 코드를 더 좋게 재구성하는 사례도 없지 않다.
• 이름을 붙일 때는 일관성이 있어야 한다. 모듈 내에서 함수 이름은 같은 문구, 명사, 동사를 사용한다.
• 함수에서 이상적인 인수 개수는 0개(무항)다. 다음은 1개고, 다음은 2개다. 3개는 가능한 피하는 편이 좋다. 4개 이상은 특별한 이유가 필요하다. 특별한 이유가 있어도 사용하면 안 된다.
• 테스트 관점에서 보면 인수는 더 어렵다. 인수가 3개를 넘어가면 인수마다 유효한 값으로 모든 조합을 구성해 테스트하기가 상당히 부담스러워진다.
• 플래그 인수는 추하다. 함수로 부울 값을 넘기는 관례는 정말로 끔찍하다. 함수가 한꺼번에 여러 가지를 처리한다고 대놓고 공표하는 셈이니까! 플래그가 참이면 이걸 하고 거짓이면 저걸 한다는 말이니까!
• 이항 함수가 무조건 나쁘다는 소리는 아니다. 하지만 그만큼 위험이 따른다는 사실을 이해하고 가능하면 단항 함수로 바꾸도록 애써야 한다.
• 인수가 2-3개 필요하다면 일부를 독자적인 클래스 변수로 선언할 가능성을 짚어본다.
• 가변 함수를 취하는 함수는 단항, 이항, 삼항 함수로 취급할 수 있다.
• 함수의 의도나 인수의 순서와 의도를 제대로 표현하려면 좋은 함수 이름이 필수다. 단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야 한다.

• 함수 이름에 키워드를 추가하는 형식이 있다.

  assertEquals(expected, actual) -> assertExpectedEqualsActual(expected, actual)

• 부수 효과는 거짓말이다. 함수에서 한 가지를 하겠다고 약속하고선 남몰래 다른 짓도 하니까.
• 만약 시간적인 결합이 필요하다면 함수 이름에 분명히 명시한다.
• 함수 선언부를 찾아보는 행위는 코드를 보다가 주춤하는 행위와 동급이다. 인지적으로 거슬린다는 뜻이므로 피해야 한다.
• 함수는 뭔가를 수행하거나 뭔가에 답하거나 둘 중 하나만 해야 한다. 객체 상태를 변경하거나 아니면 객체 정보를 반환하거나 둘 중 하나다.
• 오류 코드보다 예외를 사용하라! 명령 함수에서 오류 코드를 반환하는 방식은 명령/조회 분리 규칙을 미묘하게 위반한다. 오류 코드를 반환하면 호출자는 오류 코드를 곧바로 처리해야 한다.
• try/catch 블록은 원래 추하다. 코드 구조에 혼란을 일으키며, 정상 동작과 오류 처리 동작을 뒤섞는다. 정상 동작과 오류 처리 동작을 분리하면 코드를 이해하고 수정하기 쉬워진다.
• 오류 코드 대신 예외를 사용하면 새 예외는 Exception 클래스에서 파생된다. 따라서 재컴파일/재배치 없이도 새 예외 클래스를 추가할 수 있다.
• 반복하지 마라! 중복을 없앴더니 모듈 가독성이 크게 높아졌다는 사실을 깨달으리라.
• 중복은 소프트웨어에서 모든 악의 근원이다. 많은 원칙과 기법이 중복을 없애거나 제어할 목적으로 나왔다.
• 소프트웨어를 짜는 행위는 여느 글짓기와 비슷하다. 처음에는 길고 복잡하다. 들여쓰기 단계도 많고 중복된 루프도 많다. 인수 목록도 아주 길다. 이름은 즉흥적이고 코드를 중복된다. 하지만 나는 그 서투른 코드를 빠짐없이 테스트하는 단위 테스트 케이스도 만든다.
• 그런 다음 나는 코드를 다듬고, 함수를 만들고, 이름을 바꾸고, 중복을 제거한다. 메서드를 줄이고 순서를 바꾼다. 때로는 전체 클래스를 쪼개기도 한다. 이 와중에도 코드는 항상 단위 테스트를 통과한다.
• 최종적으로는 이 장에서 설명한 규칙을 따르는 함수가 얻어진다. 처음부터 탁 짜내지 않는다. 그게 가능한 사람을 없으리라.
• 프로그래밍의 기술은 언제나 언어 설계의 기술이다.
• 여러분이 작성하는 함수가 분명하고 정확한 언어로 깔끔하게 같이 맞아떨어져야 이야기를 풀어나가기가 쉬워진다는 사실을 기억하기 바란다.

감상

• 하나의 함수에서 한 가지 일만 해야한다는 말을 많이 들었고 코드 리뷰에서도 그런 리뷰를 종종 받았었다. 근데 읽다보니 지키지 못하고 있었던 게 많다는 생각이 들었다.
• 오류 처리를 할 때 오류 동작을 구분하고, 인수는 적게 설정하고, if문 등의 중첩 구조를 줄이는 것들을 지키지 못한 코드가 많이 생각났다.
• 이전 장에서도 이름짓기의 중요성을 강조했었는데, 함수 이름을 짓는 것도 중요하다고 한다. 함수에 인수가 들어가는 경우에는 선언부를 찾아보지 않고도 인수와 함수의 의미를 알기 쉽도록 이름을 지어야 한다고 한다. 인수가 들어가는 경우나 그렇지 않은 경우라도 의미를 알기 쉽지 않아 선언부를 찾아본 일이 적지 않은데 그 문제를 단순히 이름을 명확히 짓는 것으로 해결할 수 있다는 것에 새로웠다.
• 최근 같은 내용을 구현한 여러 사람들의 코드를 읽을 일이 있었다. 함수를 최대한 작게 쪼갠 함수는 이야기처럼 술술 읽기 쉬웠고, 함수를 분리하지 않고 한 곳에 몰아넣은 코드는 이해하는데 오래 걸렸다.
• 헤밍웨이가 초고는 쓰레기라고 했다. 글쓴이도 코드를 여러번 수정함으로써 이 장의 규칙을 따르는 코드를 얻을 수 있다고 했다. 다른 사람들의 코드를 볼 때 여러번 수정한 코드와 한 번만에 짜낸 코드는 차이가 보였다. 코드를 여러번 수정할수록 이 책에서 말하는 클린 코드를 작성할 수 있겠다는 생각이 들었다. 글쓴이 같은 사람들은 한 번만에 깔끔한 코드를 작성할 수 있지 않을까 했는데 그게 가능한 사람은 없을 것이라고 한다.

4장. 주석

내용

• 나쁜 코드에 주석을 달지 마라. 새로 짜라.
• 잘 달린 주석은 그 어떤 정보보다 유용하다. 경솔하고 근거 없는 주석은 코드를 이해하기 어렵게 만든다. 오래되고 조잡한 주석은 거짓과 잘못된 정보를 퍼뜨려 해악을 미친다.
• 우리에게 프로그래밍 언어를 치밀하게 사용해 의도를 표현할 능력이 있다면, 주석은 전혀 필요하지 않으리라.
• 우리는 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다.
• 때때로 주석 없이는 자신을 표현할 방법을 찾지 못해 할 수 없이 주석을 사용한다. 그래서 주석은 반겨 맞을 손님이 아니다.
• 주석을 달 때마다 자신에게 표현력이 없다는 사실을 푸념해야 마땅하다.
• 주석은 오래될수록 코드에서 멀어진다.
• 나라면 코드를 깔끔하게 정리하고 표현력을 강화하는 방향으로, 그래서 애초에 주석이 필요 없는 방향으로 에너지를 쏟겠다.
• 더 이상 지킬 필요가 없는 규칙이나 지켜서는 안 되는 규칙을 명시한다.
• 진실은 한 곳에만 존재한다. 바로 코드다. 그러므로 우리는 주석을 가능한 줄이도록 꾸준히 노력해야 한다.
• 코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다.
• 자신이 저지른 난장판을 주석으로 설명하려 애쓰는 대신에 그 난장판을 깨끗이 치우는 데 시간을 보내라!
• 많은 경우 주석으로 달려는 설명을 함수로 만들어 표현해도 충분하다.

• 좋은 주석

  • 때때로 주석은 구현을 이해하게 도와주는 선을 넘어 결정에 깔린 의도까지 설명한다.
  • 인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 주석이 유용하다.
• 주기적으로 TODO 주석을 점검해 없애도 괜찮은 주석은 없애라고 권한다.

• 나쁜 주석

  • 대다수 주석은 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화하는 등 프로그래머가 주절거리는 독백에서 크게 벗어나지 못한다.
  • 특별한 이유 없이 의무감으로 혹은 프로세스에서 하라고 하니까 마지못해 주석을 단다면 전적으로 시간낭비다. 주석을 달기로 결정했다면 충분한 시간을 들여 최고의 주석을 달도록 노력한다.
  • 이해가 안 되어 다른 모듈까지 뒤져야 하는 주석은 독자와 제대로 소통하지 못하는 주석이다. 그런 주석은 바이트만 낭비할 뿐이다.
  • 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석은 있으나 마나 한 주석이다.
  • 위와 같은 주석은 지나친 참견이라 개발자가 주석을 무시하는 습관에 빠진다. 코드를 읽으며 자동으로 주석을 건너뛴다. 결국은 코드가 바뀌면서 주석은 거짓말로 변한다.
  • 있으나 마나 한 주석을 달려는 유혹에서 벗어나 코드를 정리하라. 더 낫고, 행복한 프로그래머가 되는 지름길이다.
  • 주석으로 처리한 코드만큼 밉살스러운 관행도 드물다. 주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다. 이유가 있어 남겨놓았으리라고, 중요하니까 지우면 안 된다고 생각한다. 쓸모 없는 코드가 점차 쌓여간다.
  • 소스 코드 관리 시스템이 우리를 대신해 코드를 기억해준다. 이제는 주석으로 처리할 필요가 없다. 그냥 코드를 삭제하라. 잃어버릴 염려는 없다. 약속한다.
• 주석을 달아야 한다면 근처에 있는 코드만 기술하라. 코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하지 마라.
• 주석에다 흥미로운 역사나 관련 없는 정보를 장황하게 늘어놓지 마라.
• 주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다.
• 주석을 다는 목적은 코드만으로 설명이 부족해서다. 주석 자체가 다시 설명을 요구하면 안타깝기 그지없다.
• 짧고 한 가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋다.

감상

• 입사 초기에 시간 안에 요구사항대로 제대로 동작하는 것만을 목표로 해서 코드를 작성한 적이 있었다. 그러다보니 지저분한 코드라는 걸 알면서도 일단 했었는데, 나중의 독자를 위해서 주석을 남겨놨었다. 하지만 이 장을 읽고나니 주석이 필요없도록 깔끔한 코드를 작성하는 것이 우선이라는 것을 알게 됐다.
• 오래된 주석일수록 진실과 멀어진다는 말에 공감이 됐다. 사용하지 않을 경우 삭제하기 등의 주석을 종종 보기도 하고 내가 남겨놓기도 했다. 하지만 커밋 날짜가 오래될수록 사용하지 않는 기능을 없애는 일은 잘 하지 않게 되고, 리팩토링은 우선순위에서 밀려나게 된다. 우연히 그런 코드를 보게 돼도 지금 없애도 되는건가 하는 생각에 굳이 없애지 않고 지나치게 되었다.
• 쓰다가 나중에 필요할 것 같은 코드는 깃에 다 남게 되는데도 주석으로 남겨둔 경우가 많았다. 커밋 메세지를 잘 남겨놓는다면 다시 필요하게 될 때도 쉽게 찾을 수 있으니 쓸모없는 코드는 바로 삭제해야겠다.
• TODO를 주기적으로 점검하라고 해서 최근 작업한 레포지토리를 보니 TODO 주석이 꽤 남아있다. 점검 후에 없앨 수 있는 것들은 없애봐야겠다.
• 주석이 코드를 설명하기에 좋은 방법이라고 생각했었는데 생각보다 코드에 주석을 남겨놓는 경우가 없었다. 근데 이 장을 읽으며 주석이 필요없도록 함수를 잘 작성하는 게 좋다는 걸 알게되었다.
• 좋은 주석에 관한 내용도 있지만 주된 내용은 더러운 코드를 만회하기 위해 주석을 쓰지 말고, 쓰더라도 명백하게 쓰라는 내용이어서 뜨끔했다.

5장. 형식 맞추기

내용

• 뚜껑을 열었을 때 독자들이 코드가 깔끔하고, 일관적이며, 꼼꼼하다고 감탄하면 좋겠다. 질서 정연하다고 탄복하면 좋겠다. 모듈을 읽으며 두 눈이 휘둥그래 놀라면 좋겠다. 전문가가 짰다는 인상을 심어주면 좋겠다.
• 술 취한 뱃사람 한 무리가 짜놓은 듯 어수선해 보인다면 독자들은 프로젝트의 다른 측면도 똑같이 무성의한 태도로 처리했으리라 생각할 것이다.
• 프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야 한다. 코드 형식을 맞추기 위해 간단한 규칙을 정하고 그 규칙을 착실히 따라야 한다. 팀으로 일한다면 팀이 합의해 규칙을 정하고 모두가 그 규칙을 따라야 한다.
• 어쩌면 ‘돌아가는 코드’가 전문 개발자의 일차적인 의무라 여길지도 모르겠다. 하지만 이 책을 읽으면서 생각이 바뀌었기 바란다.
• 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다. 오랜 시간이 지나 코드가 많이 바뀌어도 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다. 원래 코드는 사라질지라도 개발자의 스타일과 규율은 사라지지 않는다.
• 일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.
• 이름은 간단하면서도 설명이 가능하게 짓는다. 이름만 보고도 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 신경 써서 짓는다. 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다. 아래로 내려갈수록 의도를 세세하게 묘사한다. 마지막에는 가장 저차원 함수와 세부 내역이 나온다.
• 각 행은 수식이나 절을 나타내고, 일련의 행 묶음은 완결된 생각 하나를 표현한다. 생각 사이는 빈 행을 넣어 분리해야 마땅하다. 패키지 선언부, import 문, 각 함수 사이에 빈 행이 들어간다.
• 빈 행은 새로운 개념을 시작한다는 시각적 단서다. 코드를 읽어내려가다 보면 빈 행 바로 다음 줄에 눈길이 멈춘다.
• 줄바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미한다. 서로 밀접한 코드 행은 세로로 가까이 놓여야 한다는 뜻이다.
• 함수나 변수가 정의된 코드를 찾으려 상속 관계를 줄줄이 거슬러 올라간 경험이 있는가? 시스템이 무엇을 하는지 이해하고 싶은데, 이 조각 저 조각이 어디에 있는지 찾고 기억하느라 시간과 노력을 소모한다.
• 서로 밀접한 개념은 세로로 가까이 둬야 한다. 물론 두 개념이 서로 다른 파일에 속한다면 규칙이 통하지 않는다. 하지만 타당한 근거가 없다면 서로 밀접한 개념은 한 파일에 속해야 마땅하다.
• 변수는 사용하는 위치에 최대한 가까이 선언한다. 우리가 만든 함수는 매우 짧으므로 지역 변수는 각 함수 맨 처음에 선언한다.
• 인스턴스 변수는 클래스 맨 처음에 선언한다. 잘 설계한 클래스는 많은 클래스 메서드가 인스턴스 변수를 사용하기 때문이다.
• 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다. 호출하는 함수를 호출되는 함수보다 먼저 배치하면 프로그램이 자연스럽게 읽힌다. 소스 코드 모듈이 고차원에서 저차원으로 자연스럽게 내려간다.
• 상수를 알아야 마땅한 함수에서 실제로 사용하는 함수로 상수를 넘겨주는 방법이 더 좋다.

• 어떤 코드는 서로 끌어당긴다. 개념적인 친화도가 높기 때문이다. 친화도가 높을수록 코드를 가까이 배치한다.

  • 한 함수가 다른 함수를 호출해 생기는 직접적인 종속성
  • 변수와 그 변수를 사용하는 함수
  • 비슷한 동작을 수행하는 일군의 함수
• 중요한 개념을 표현할 때는 세세한 사항을 최대한 배제한다. 세세한 사항은 가장 마지막에 표현한다. 그러면 독자가 소스 파일에서 첫 함수 몇 개만 읽어도 개념을 파악하기 쉬워진다.
• 프로그래머는 명백하게 짧은 행을 선호한다. 100자나 120자에 달해도 나쁘지 않다. 개인적으로는 120자 정도로 행 길이를 제한한다.

• 가로로는 공백을 사용해 밀접한 개념과 느슨한 개념을 표현한다.

  • 함수 이름과 이어지는 괄호 사이에는 공백을 넣지 않았다. 함수와 인수는 서로 밀접하기 때문이다.
  • 공백을 넣으면 한 개념이 아니라 별개로 보인다.
  • 함수를 호출하는 코드에서 괄호 안 인수는 공백으로 분리했다. 쉼표를 강조해 인수가 별개라는 사실을 보여주기 위해서다.
  • 연산자 우선순위를 강조하기 위해서도 공백을 사용한다.
• scope로 이뤄진 계층을 표현하기 위해 우리는 코드를 들여쓴다.
• 때로는 간단한 if문, 짧은 while 문, 짧은 함수에서 들여쓰기 규칙을 무시하고픈 유혹이 생긴다.
• 프로그래머라면 각자 선호하는 규칙이 있다. 하지만 팀에 속한다면 자신이 선호해야 할 규칙은 바로 팀 규칙이다.
• 팀은 한 가지 규칙에 합의해야 한다. 그리고 모든 팀원은 그 규칙을 따라야 한다. 그래야 소프트웨어가 일관적인 스타일을 보인다.
• 좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다는 사실을 기억하기 바란다. 스타일은 일관적이고 매끄러워야 한다. 한 소스 파일에서 봤던 형식이 다른 소스 파일에도 쓰이리라는 신뢰감을 독자에게 줘야 한다.

감상

• 성의에 관한 이야기가 나왔다. 다른 사람들이 작성한 코드에 대해서 얘기한 적이 있었는데, 무성의하게 작성했다는 평가가 있었다. 나는 지저분한 코드 정도로 생각했었는데, 무성의하다는 표현이 적절해보였다. 코드에서도 작가의 성의가 보인다는 게 신기했고, 내가 작성한 코드에서 무성의함이 느껴지지 않도록 성의 있게 코드를 작성하고 다듬어야겠다고 생각했다.
• ‘돌아가는 코드’가 전문 개발자의 일차적인 의무가 여기는 생각이 바뀌었으면 좋겠다고 하는데, 개발자의 일차적인 업무는 요구사항을 구현하는 것이 아닌가 생각한다.
• 알고리즘 문제를 많이 풀 때 다른 사람들의 코드를 보면서 나는 라인 수가 많은데 비해 if 문이나 while 문 등을 들여쓰기 없이 쓴 코드를 보며 간결해 보였다. 그렇게 쓰는 게 고수 같다고 생각했는데 강의를 듣거나 책을 읽으면서 그렇게 하면 안 좋다는 걸 알게 됐다. 짧고 간결해 보인다고 해서 좋은 코드는 아닌가보다.
• 팀의 규칙을 따르는 게 중요하다고 했는데, 팀에서 많이 사용하는 레포지토리에는 꽤 복잡하고 일관성 없어보이는 규칙들이 종종 보인다. 그 후에 새로 만든 레포지토리에서는 비교적 간단한 규칙을 정했는데, 처음에 팀의 규칙을 합리적으로 잘 정하는 게 중요한 것 같다.