본문 바로가기

💻Dev/Clean Code3

함수 작게 만들어라! 함수는 작을수록 좋다. 20줄도 길다. 들여쓰기(indent)는 1단이나 2단을 넘어가면 안 된다. 한 가지만 해라! 함수의 추상화 수준은 하나여야 한다. 지정된 함수 이름 아래에서 추상화 수준이 하나인 단계만 수행한다면 그 함수는 한 가지 작업만 하는 것이다. 서술적인 이름을 사용하라! 코드를 읽으면서 짐작했던 기능을 각 루틴이 그대로 수행한다면 깨끗한 코드라 불러도 되겠다. 함수가 작고 단순할수록 서술적인 이름을 고르기도 쉬워진다. 길고 서술적인 이름이 짧고 어려운 이름보다 좋다. IDE에서 이런저런 이름을 시도한 후 최대한 서술적인 이름을 골라도 좋다. 또한 이름을 붙일 때는 일관성이 있어야 한다. 모듈 내에서 함수 이름은 같은 문구, 명사, 동사를 사용한다. ex) `include.. 2023. 10. 29.
의미 있는 이름 의도를 분명히 밝혀라 변수, 함수, 클래스의 주석이 필요하다면 의도를 분명히 드러내지 못했다는 말이다. // Bad public List getThem() { List list1 = new ArrayList(); for (int[] x : theList) { if (x[0] == 4) { list1.add(x); } } return list1; } // Good public List getFlaggedCells() { List flaggedCells = new ArrayList(); for (int[] cell : gameBoard) { if (cell[STATUS_VALUE] == FLAGGED) { flaggedCells.add(cell); } } return flaggedCells; } `if (c.. 2023. 10. 18.
깨끗한 코드 깨끗한 코드는 ‘보기에 즐거운’ 코드다. 책의 서두에서 핵심이 나온 거 아닐까, 어렵게 접근하지 않기로 했다. 신입이 실무 프로젝트에 투입됐을 때 제일 먼저 하는 것은 코드를 보며 업무 프로세스를 파악하는 것이다. 이때 주석이 없어도 책처럼 읽을 수 있어야 한다. (일부의 주석은 필요하겠지만) 철저한 오류 처리 세세한 사항까지 꼼꼼하게 신경 쓰라는 말이다. 프로그래머들이 대충 넘어가는 부분 중 하나가 오류 처리다. 가독성 깨끗한 코드는 잘 쓴 문장처럼 읽혀야 한다. 다른 사람이 고치기 쉽다. TDD 테스트 케이스가 없는 코드는 깨끗한 코드가 아니다. 아무리 코드가 우아해도, 아무리 가독성이 높아도, 테스트 케이스가 없으면 깨끗하지 않다. 중복 같은 작업을 여러 차례 반복한다면 코드가 아이디어를 제대로 표.. 2023. 10. 17.