리팩토링 | Code Readability 위한 방법

호떡·2022년 12월 2일
0

가독성이 좋은 코드

  1. 변수, 메서드 이름을 짓는데 공들여라.
    소개되는 빨간색 이름들은 마틴 파울러가 정한 이름
    마틴파울러 refactoring 사이트

  2. 매직넘버 치환하기

    // 85라는 매직넘버를 상수로 치환한다
    public final static int MAX_BOOTING_TICK_COUNT = 85;

    while(MAX_BOOTING_TICK_COUNT <= getTickCount()) {

    }
  1. 상수 의존관계
    상수끼리 관계가 있는 경우, 관계를 표시하도록 해주는 것이 가독성에 더 좋다.
    public final static int BOOT_AREA_KB = 200;
    public final static int HEAP_AREA_KB = BOOT_AREA_KB * 4;
  1. flag 보다는 found가 더 명확
    찾았다는 의미로 boolean 타입의 flag 변수를 선언하지만, 그보다 의미가 좀 더 명확하도록 found나 exsist 변수로 선언하면 더 좋다.

  2. 명확한 함수명 사용

  3. Extract Function
    메서드는 하나의 역할만 하도록 하나의 함수로 뺀다. 대체로 주석을 달게 되는 로직(하나의 덩어리)을 하나의 함수로 뺀다. 또한 함수명을 적절하게 붙인다면, 그것이 주석의 역할을 대신한다.

  4. 파라미터 객체를 만들어 사용하기
    두 개 이상의 변수가 같이 사용되는 경우가 빈번할 때

	class Node {
        int r,c;
    }
  1. flag 변수 제거하기
    flag라는 변수를 사용하기 보다는 isSame() 혹은 isEmpty(), isExist() 라는 메서드를 하나 만들어 사용한다.

  2. 다형성을 이용해 switch문을 제거할 수 있다.
    타입 코드에 대한 switch 문이면 상속과 다형성으로 처리

0개의 댓글