Чистый код. Создание, анализ и рефакторинг

    int straightTime = Math.min(tenthsWorked, TENTHS_PER_WEEK);

    int overTime = tenthsWorked - straightTime;

    return new Money(

      grade.rate() * (tenthsWorked + OVERTIME_RATE * overTime)

    );

  }

  ...

}

public enum HourlyPayGrade {

  APPRENTICE {

    public double rate() {

      return 1.0;

    }

  },

  LEUTENANT_JOURNEYMAN {

    public double rate() {

      return 1.2;

    }

  },

  JOURNEYMAN {

    public double rate() {

      return 1.5;

    }

  },

  MASTER {

    public double rate() {

      return 2.0;

    }

  };

  public abstract double rate();

}

Имена

N1: Используйте содержательные имена

Не торопитесь с выбором имен. Позаботьтесь о том, чтобы имена были содержательными. Помните, что смысл может изменяться в ходе развития программного продукта; почаще переосмысливайте уместность выбранных вами имен.

Не рассматривайте это как дополнительный «фактор комфортности». Имена в программных продуктах на 90% определяют удобочитаемость кода. Не жалейте времени на то, чтобы выбрать их осмысленно, и поддерживайте их актуальность. Имена слишком важны, чтобы относиться к ним легкомысленно.

Возьмем следующий код. Что он делает? Когда я представлю вам тот же код с нормально выбранными именами, вы моментально поймете его смысл, но в этом виде он представляет собой мешанину из символов и «волшебных чисел».

public int x() {

    int q = 0;

    int z = 0;

    for (int kk = 0; kk < 10; kk++) {

      if (l[z] == 10)

      {

        q += 10 + (l[z + 1] + l[z + 2]);

        z += 1;

      }

      else if (l[z] + l[z + 1] == 10)

      {

        q += 10 + l[z + 2];

        z += 2;

      } else {

        q += l[z] + l[z + 1];

        z += 2;

      }

    }

    return q;

  }

А вот как должен был выглядеть этот код. Вообще говоря, этот фрагмент чуть менее полон, чем приведенный выше. И все же вы сразу догадаетесь, что мы пытаемся сделать, и с большой вероятностью сможете написать отсутствующие функции, основываясь на своих предположениях. «Волшебные числа» перестали быть волшебными, а структура алгоритма радует своей очевидностью.

public int score() {

  int score = 0;

  int frame = 0;

  for (int frameNumber = 0; frameNumber < 10; frameNumber++) {

    if (isStrike(frame)) {

      score += 10 + nextTwoBallsForStrike(frame);

      frame += 1;

    } else if (isSpare(frame)) {

      score += 10 + nextBallForSpare(frame);

      frame += 2;

    } else {

      score += twoBallsInFrame(frame);

      frame += 2;

    }

  }

  return score;

}

Сила хорошо выбранных имен заключается в том, что они дополняют структуру кода описаниями. На основании этих описаний у читателя формируются определенные предположения по поводу того, что делают другие функции модуля. Взглянув на приведенный код, вы сможете представить себе примерную реализацию isStrike(). А при чтении метода isStrike() становится очевидно, что он делает «примерно то, что предполагалось»[76].

private boolean isStrike(int frame) {

  return rolls[frame] == 10;

}

N2: Выбирайте имена на подходящем уровне абстракции

Не используйте имена, передающие информацию о реализации. Имена должны отражать уровень абстракции, на котором работает класс или функция. Сделать это непросто — и снова потому, что люди слишком хорошо справляются со смешением разных уровней абстракции. При каждом просмотре кода вам с большой вероятностью попадется переменная, имя которой выбрано на слишком низком уровне. Воспользуйтесь случаем и измените его. Чтобы ваш код хорошо читался, вы должны серьезно относиться к его непрерывному совершенствованию. Возьмем следующий интерфейс Modem:

public interface Modem {

  boolean dial(String phoneNumber);

  boolean disconnect();

  boolean send(char c);

  char recv();

  String getConnectedPhoneNumber();

}