Качество кода

  Качество кода 

Отладка в браузере Chrome

На текущий момент самые многофункциональные инструменты – в браузере Chrome. Также очень хорош Firebug (для Firefox).

На фото выше есть 3 зоны: 
  1. Зона исходных файлов. В ней находятся все подключённые к странице файлы, включая JS/CSS. Выберите pow.js, если он не выбран.
  2. Зона текста. В ней находится текст файлов.
  3. Зона информации и контроля. Мы поговорим о ней позже.

Брейкпойнт (breakpoint) – часто используемый английский жаргонизм. Это то место в коде, где отладчик будет автоматически останавливать выполнение JavaScript, как только оно до него дойдёт.

Правый клик на номер строки открывает контекстное меню, в котором можно запустить выполнение кода до неё (Continue to here). Это удобно, когда хочется сразу прыгнуть вперёд и breakpoint неохота ставить.
Ход выполнения задачи можно выполнить вручную:
function pow(x, n) {
  ...
  debugger; // <-- отладчик остановится тут
  ...
}


 – продолжить выполнение, горячая клавиша F8.
 – сделать шаг, не заходя внутрь функции, горячая клавиша F10.
 – сделать шаг, горячая клавиша F11.
 – выполнять до выхода из текущей функции, горячая клавиша Shift+F11.
 – отключить/включить все точки останова.
 – включить/отключить автоматическую остановку при ошибке.

Самая любимая команда разработчиков: console.log(...).
Она пишет переданные ей аргументы в консоль, например:
// результат будет виден в консоли
for (var i = 0; i < 5; i++) {
  console.log("значение", i);
}

Итого    Отладчик позволяет:


  • Останавливаться на отмеченном месте (breakpoint) или по команде debugger.
  • Выполнять код – по одной строке или до определённого места.
  • Смотреть переменные, выполнять команды в консоли и т.п.


Советы по стилю кода


  • Имя переменной – существительное.
  • Имя функции – глагол или начинается с глагола. Бывает, что имена для краткости делают существительными, но глаголы понятнее.
  • Для имён используется английский язык (не транслит) и верблюжья нотация.
Главное для нас – не краткость кода, а его простота и читаемость. Совсем не всегда более короткий код проще для понимания, чем более развёрнутый.
Должен быть минимум комментариев, которые отвечают на вопрос «что происходит в коде?»
Что интересно, в коде начинающих разработчиков обычно комментариев либо нет, либо они как раз такого типа: «что делается в этих строках».
Серьёзно, хороший код и так понятен.
Об этом замечательно выразился Р.Мартин в книге «Чистый код»: «Если вам кажется, что нужно добавить комментарий для улучшения понимания, это значит, что ваш код недостаточно прост, и, может, стоит переписать его».
А какие комментарии полезны и приветствуются?
  • Архитектурный комментарий – «как оно, вообще, устроено».
    Для описания архитектуры, кстати, создан специальный язык UML, красивые диаграммы, но можно и без этого. Главное – чтобы понятно.
  • Справочный комментарий перед функцией – о том, что именно она делает, какие параметры принимает и что возвращает.
    Для таких комментариев существует синтаксис JSDoc.
    /**
     * Возвращает x в степени n, только для натуральных n
     *
     * @param {number} x Число для возведения в степень.
     * @param {number} n Показатель степени, натуральное число.
     * @return {number} x в степени n.
     */
    function pow(x, n) {
      ...
    }
    Такие комментарии позволяют сразу понять, что принимает и что делает функция, не вникая в код.
    Кстати, они автоматически обрабатываются многими редакторами, например Aptana и редакторами от JetBrains, которые учитывают их при автодополнении, а также выводят их в автоподсказках при наборе кода.
    Кроме того, есть инструменты, например JSDoc 3, которые умеют генерировать по таким комментариям документацию в формате HTML. Более подробную информацию об этом можно также найти на сайте http://usejsdoc.org/.
Существуют средства, проверяющие стиль кода. Самые известные – это:
  • JSLint – проверяет код на соответствие стилю JSLint, в онлайн-интерфейсе вверху можно ввести код, а внизу различные настройки проверки, чтобы сделать её более мягкой.
  • JSHint – вариант JSLint с большим количеством настроек.
  • Closure Linter – проверка на соответствие Google JavaScript Style Guide.

Тестирование кода

BDD – поведенческие тесты кода

Мы рассмотрим методику тестирования, которая входит в BDD – Behavior Driven Development. Подход BDD давно и с успехом используется во многих проектах.
BDD – это не просто тесты. Это гораздо больше.
Тесты BDD – это три в одном: И тесты, И документация, И примеры использования.
Впрочем, хватит слов. Рассмотрим примеры.

Разработка pow: спецификация

Допустим, мы хотим разработать функцию pow(x, n), которая возводит x в целую степень n, для простоты n≥0.
Ещё до разработки мы можем представить себе, что эта функция будет делать, и описать это по методике BDD.
Это описание называется спецификация (или, как говорят в обиходе, «спека») и выглядит так:
describe("pow", function() {

  it("возводит в n-ю степень", function() {
    assert.equal(pow(2, 3), 8);
  });

});
У спецификации есть три основных строительных блока, которые вы видите в примере выше:
describe(название, function() { ... })
Задаёт, что именно мы описываем, используется для группировки «рабочих лошадок» – блоков it. В данном случае мы описываем функцию pow.
it(название, function() { ... })
В названии блока it человеческим языком описывается, что должна делать функция, далее следует тест, который проверяет это.
assert.equal(value1, value2)
Код внутри it, если реализация верна, должен выполняться без ошибок.
Различные функции вида assert.* используются, чтобы проверить, делает ли pow то, что задумано. Пока что нас интересует только одна из них – assert.equal, она сравнивает свой первый аргумент со вторым и выдаёт ошибку в случае, когда они не равны. В данном случае она проверяет, что результат pow(2, 3) равен 8.
Есть и другие виды сравнений и проверок, которые мы увидим далее.

Для запуска тестов нужны соответствующие JavaScript-библиотеки.
Мы будем использовать:
  • Mocha – эта библиотека содержит общие функции для тестирования, включая describe и it.
  • Chai – библиотека поддерживает разнообразные функции для проверок. Есть разные «стили» проверки результатов, с которыми мы познакомимся позже, на текущий момент мы будем использовать лишь assert.equal.
  • Sinon – для эмуляции и хитрой подмены функций «заглушками», понадобится позднее.

Уточнение реализации

Придётся написать нечто более реальное, чтобы тесты проходили:
function pow(x, n) {
  var result = 1;

  for (var i = 0; i < n; i++) {
    result *= x;
  }

  return result;
}
Чтобы быть уверенными, что функция работает верно, желательно протестировать её на большем количестве значений. Вместо того, чтобы писать блоки it вручную, мы можем сгенерировать тесты в цикле for:
describe("pow", function() {

  function makeTest(x) {
    var expected = x * x * x;
    it("при возведении " + x + " в степень 3 результат: " + expected, function() {
      assert.equal(pow(x, 3), expected);
    });
  }

  for (var x = 1; x <= 5; x++) {
    makeTest(x);
  }

});
Результат:

Функция makeTest и цикл for, очевидно, нужны друг другу, но не нужны для других тестов, которые мы добавим в дальнейшем. Они образуют единую группу, задача которой – проверить возведение в n-ю степень.
Будет правильно выделить их, при помощи вложенного блока describe:



















describe("pow", function() {

  describe("возводит x в степень n", function() {

    function makeTest(x) {
      var expected = x * x * x;
      it("при возведении " + x + " в степень 3 результат: " + expected, function() {
        assert.equal(pow(x, 3), expected);
      });
    }

    for (var x = 1; x <= 5; x++) {
      makeTest(x);
    }

  });

  // ... дальнейшие тесты it и подблоки describe ...
});
В будущем мы сможем добавить другие тесты it и блоки describe со своими вспомогательными функциями.
before/after и beforeEach/afterEach
В каждом блоке describe можно также задать функции before/after, которые будут выполнены до/после запуска тестов, а также beforeEach/afterEach, которые выполняются до/после каждого it.
Например:
describe("Тест", function() {

  before(function() { alert("Начало тестов"); });
  after(function() { alert("Конец тестов"); });

  beforeEach(function() { alert("Вход в тест"); });
  afterEach(function() { alert("Выход из теста"); });

  it('тест 1', function() { alert('1'); });
  it('тест 2', function() { alert('2'); });

});
Последовательность будет такой:
Начало тестов
Вход в тест
1
Выход из теста
Вход в тест
2
Выход из теста
Конец тестов
Как правило, beforeEach/afterEach (before/after) используют, если необходимо произвести инициализацию, обнулить счётчики или сделать что-то ещё в таком духе между тестами (или их группами).

Другие assert

Вот самые востребованные assert-проверки, встроенные в Chai:
  • assert(value) – проверяет что value является true в логическом контексте.
  • assert.equal(value1, value2) – проверяет равенство value1 == value2.
  • assert.strictEqual(value1, value2) – проверяет строгое равенство value1 === value2.
  • assert.notEqual, assert.notStrictEqual – проверки, обратные двум предыдущим.
  • assert.isTrue(value) – проверяет, что value === true
  • assert.isFalse(value) – проверяет, что value === false
  • …более полный список – в документации
В нашем случае хорошо бы использовать проверку assert.isNaN, и такой метод существует, но сейчас мы рассматриваем самый общий метод assert(...). В этом случае для того, чтобы сделать сообщение об ошибке понятнее, желательно добавить к assert описание.
describe("pow", function() {

  describe("возводит x в степень n", function() {

    function makeTest(x) {
      var expected = x * x * x;
      it("при возведении " + x + " в степень 3 результат: " + expected, function() {
        assert.equal(pow(x, 3), expected);
      });
    }

    for (var x = 1; x <= 5; x++) {
      makeTest(x);
    }

  });

  it("при возведении в отрицательную степень результат NaN", function() {
    assert(isNaN(pow(2, -1)), "pow(2, -1) не NaN");
  });

  it("при возведении в дробную степень результат NaN", function() {
    assert(isNaN(pow(2, 1.5)), "pow(2, -1.5) не NaN");
  });

  describe("любое число, кроме нуля, в степени 0 равно 1", function() {

    function makeTest(x) {
      it("при возведении " + x + " в степень 0 результат: 1", function() {
        assert.equal(pow(x, 0), 1);
      });
    }

    for (var x = -5; x <= 5; x += 2) {
      makeTest(x);
    }

  });

  it("ноль в нулевой степени даёт NaN", function() {
    assert(isNaN(pow(0, 0)), "0 в степени 0 не NaN");
  });

});

Эту спецификацию можно использовать как:
  1. Тесты, которые гарантируют правильность работы кода.
  2. Документацию по функции, что она конкретно делает.
  3. Примеры использования функции, которые демонстрируют её работу внутри it.
p.s. есть смысл порешать задачи - не всё понятно.

Комментарии