00. 개요

  • 5S 철학

    • 정리 (Seirl)
    • 정돈 (Seiton)
    • 청소 (Seiso)
    • 청결 (Seiketsu)
    • 생활화 (shutsuke)
  • 코드 품질을 측정하는 유일한 척도 = 분당 내지르는 "WTF" 회수
  • 장인 정신을 익히는 2단계 과정
    • 이론
      • 원칙. 패턴, 기법, 경험
    • 실전
      • 이론을 바탕으로 한 지식을 몸과 마음으로 체득
  • 학습(學習) : 배우고 익히다


우리는 우리의 행위(코드작성)에 대하여 항상 이유(근거)가 있어야 한다.

01. 깨끗한 코드

  • AI가 개발자를 대체할까?
    • 코드는 요구사항을 상세히 표한하는 수단
    • 기계가 실행할 정도로 상세하게 요구사항을 명시하는 작업, 이것이 프로그래밍
    • 요구사항을 모호하게 줘도 우리 의도를 정확히 꿰뚫어 프로그램을 완벽하게 실행하는 기계는 없을 것이다.
  • 나쁜코드
    • 르블랑의 법칙 : 나중은 켤코 오지 않는다.
    • 나쁜코드는 생산성을 떨어 뜨립니다.
    • 깨끗한 코드를 만드는 노력이 비용을 절감하는 방법일 뿐만 아니라 전문가로서 살아남는 길을 인정하라.
  • 태도
    • 일정에 쫓기더라도 대다수 관리자는 좋은 코드를 원한다.
    • 그들이 일정과 요구사항을 강력하게 밀어붙이는 이유는 그것이 그들의 책임이기 때문이다.
    • 좋은 코드를 사수하는 일은 바로 우리 프로그래머들의 책임이다.
    • 어느 환자가 수술전에 손을 씻지 말라고 요구한다. 시간이 너무 걸리니까. 확실히 환자는 상사다.
      • 환자 말을 그대로 따르는 행동은 전문가 답지 못하다.
      • 나쁜 코드의 위험을 이해하지 못하는 관리자 말을 그대로 따르는 행동은 전문가 답지 못하다.

비야네 스트롭스트룹(Bjarne Stroustrup / C++창시자이자 The C++ Programming Language저자)

  • 나는 우아하고 효율적인 코드를 좋아한다.
  • 논리가 간단해야 버그가 숨어들지 못한다.
  • 의존성을 최대한 줄여야 유지 보수가 쉬워진다.
  • 오류는 명백한 전략에 의거해 철저히 처리한다.
  • 성능을 최적으로 유지해야 사람들이 원칙 없는 최적화로 코드를 망치려는 유혹에 빠지지 않는다.
  • 깨끗한 코드는 한 가지를 제대로 한다.

그래디 부치 (Grady Booch / Object Oriented Analysis and Design with Application 저자)

  • 깨끗한 코드는 단순하고 직접적이다.
  • 깨끗한 코드는 잘 쓴 문장처럼 읽힌다.
  • 깨끗한 코드는 결코 설계자의 의도를 숨기지 않는다.
  • 명쾌한 추상화와 단순한 제어문으로 가득하다.

큰 데이브 토마스 (Big Dave Thomas / OTI창립자이자 이클립스 전략의 대부)

  • 깨끗한 코드는 작성자가 아닌 사람도 읽기 쉽고 고치기 쉽다.
  • 단위 테스트 케이스와 인수 테스트 케이스가 존재한다.
  • 깨끗한 코드에는 의미 있는 이름이 붙는다.
  • 특정 목적을 달성하는 방법은 하나만 제공한다.
  • 의존성은 최소이며 각 의존성을 명확히 정의한다.
  • API는 명확하며 최소로 줄였다.
  • 언어에 따라 필요한 모든 정보를 코드 만으로 명확히 표현할 수 없기에 코드는 문학적으로 표현해야 마땅하다.

마이클 페더스 (Michael Feathers / Working Effectively with Legacy Code 저자)

  • 깨끗한 코드의 특징은 많지만 그 중에서도 모두를 아우르는 특징이 하나 있다.
  • 깨끗한 코드는 언제나 누군가 주의 깊게 짰다는 느낌을 준다.
  • 고치려고 살펴봐도 딱히 손 댈 곳이 없다.
  • 작성자가 이미 모든 사항을 고려했으므로, 고칠 궁리를 하다 보면 언제나 제자리로 돌아온다.
  • 그리고는 누군가 남겨준 코드 누군가 주의 깊게 짜 놓은 작품에 감사를 느낀다.

론 제프리스 (Ron Jeffries / Extreme Programming Installed와 Extreme Programming Adventure in C# 저자)

  • 모든 테스트를 통과한다.
  • 중복이 없다.
  • 시스템 내 모든 설계 아이디어를 표현한다.
  • 클래스, 메서드, 함수 등을 최대한 줄인다.

워드 커닝햄 (Ward Cunningham / Wiki창시자, Fit창시자, XP공동 창시자 ...)

  • 코드를 읽으면서 짐작했던 기능을 각 루틴이 그대로 수행한다면 깨끗한 코드라 불러도 되겠다.
  • 코드가 그 문제를 풀기 위한 언어처럼 보인다면 아름다운 코드라 불러도 되겠다.

코드읽기9 vs 코드짜기1

  1. 개발자가 코드를 입력한다.
  2. 변경할 함수로 스크롤해 내려간다.
  3. 잠시 멈추고 생각한다.
  4. 이런! 모듈 상단으로 스크롤해 변수 초기화를 확인한다.
  5. 다시 스크롤해 내려와 입력하기 시작한다.
  6. 이런! 입력을 지운다!
  7. 다시 입력한다.
  8. 다시 지운다!
  9. 뭔가를 절반쯤 입력하다가 또 지운다!
  10. 지금 바꾸려는 함수를 호출하는 함수로 스크롤한 후 함수가 호출되는 방식을 살펴본다.
  11. 다시 돌아와 방금 지운 코드를 입력한다.
  12. 잠시 멈춘다.
  13. 코드를 다시 지운다!
  14. 다른 창을 열어 하위 클래스를 살핀다. 함수가 재정의 되었는가?
  15. ~~~~

보이스카우트 규칙

  • 캠프장은 처음 왔을 때보다 더 깨끗하게 해놓고 떠나라!

02. 의미 있는 이름

의도를 분명히 밝혀라

Worst
int d; //경과시간(단위: 날짜)
Best
int elapsedTimeInDays;
int daysSinceCreation;
int daysSinceModification;
int fileAgeInDays;

Worst
public List<int[]> getThem() {
	List<int[]> list1 = new ArrayList<int[]>();
	for (int[] x : theList)
		if (x[0] == 4)
			list1.add(x);
	return list1;
}
Good
public List<int[]> getFlaggedCells() {
	List<int[]> flaggedCells = new ArrayList<int[]>();
	for (int[] cell : gameBoard)
		if (cell[STATUS_VALUE] == FLAGGED)
			flaggedCells.add(cell);
	return flaggedCells;
}
Good
public List<int[]> getFlaggedCells() {
	List<int[]> flaggedCells = new ArrayList<int[]>();
	for (int[] cell : gameBoard)
		if (cell[STATUS_VALUE] == FLAGGED)
			flaggedCells.add(cell);
	return flaggedCells;
}




03. 함수

04. 주석

05. 형식 맞추기

06. 객체와 자료 구조

07. 오류 처리

08. 경계

09. 단위테스트

10. 클래스

11. 시스템

12. 창발성

13. 동시성

14. 점진적인 개선

15. Junit 들여다보기

16. SerialDate 리펙터링

17. 냄새와 휴리스틱


  • No labels
Write a comment…