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

Прежде я использовал это правило, чтобы мне не приходилось прокручивать программный код вправо. Но современные мониторы стали настолько широкими, а молодые программисты выбирают настолько мелкие шрифты, что на экране помещается до 200 символов. Не делайте этого. Лично я установил себе «верхнюю планку» в 120 символов.

Горизонтальное разделение и сжатие

Горизонтальные пропуски используются для группировки взаимосвязанных элементов и разделения разнородных элементов. Рассмотрим следующую функцию:

  private void measureLine(String line) {

    lineCount++;

    int lineSize = line.length();

    totalChars += lineSize;

    lineWidthHistogram.addLine(lineSize, lineCount);

    recordWidestLine(lineSize);

  }

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

С другой стороны, я не стал отделять имена функций от открывающих скобок. Это обусловлено тем, что имя функции тесно связано с ее аргументами. Пробелы изолируют их вместо того, чтобы объединять. Я также разделил аргументы в скобках пробелами, чтобы выделить запятые и подчеркнуть, что аргументы не зависят друг от друга.

Пробелы также применяются для визуального обозначения приоритета операторов:

public class Quadratic {

  public static double root1(double a, double b, double c) {

    double determinant = determinant(a, b, c);

    return (-b + Math.sqrt(determinant)) / (2*a);

  }

  public static double root2(int a, int b, int c) {

    double determinant = determinant(a, b, c);

    return (-b - Math.sqrt(determinant)) / (2*a);

  }

  private static double determinant(double a, double b, double c) {

    return b*b - 4*a*c;

  }

}

Обратите внимание, как хорошо читаются формулы. Между множителями нет пробелов, потому что они обладают высоким приоритетом. Слагаемые разделяются пробелами, так как сложение и вычитание имеют более низкий приоритет.

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

Горизонтальное выравнивание

Когда я был ассемблерным программистом[23], горизонтальное выравнивание использовалось для визуального выделения некоторых структур. Когда я перешел на C, C++, а в конце концов и на Java, я продолжал выравнивать все имена переменных в группах объявлений или все правосторонние значения в группах команд присваивания. Мой код выглядел примерно так:

public class FitNesseExpediter implements ResponseSender

{

  private   Socket          socket;

  private   InputStream     input;

  private   OutputStream    output;

  private   Request         request;

  private   Response        response;

  private   FitNesseContext context;

  protected long            requestParsingTimeLimit;

  private   long            requestProgress;

  private   long            requestParsingDeadline;

  private   boolean         hasError;

  public FitNesseExpediter(Socket s,

                           FitNesseContext context) throws Exception

  {

    this.context =            context;

    socket =                  s;

    input =                   s.getInputStream();

    output =                  s.getOutputStream();

    requestParsingTimeLimit = 10000;

  }