Практичное качество кода — в коммуникации и разработке

Качество —
степень в которой система свободна от дефектов, относительно сферы её функций.

Качественный код

• аспекты
  • преимущества
  • проблемы
  • подходы

Код который работает

• говорит что делает
• делает что говорит
• говорит что не делает
• не делает что не говорит

Цели кода

1. Сформулированы
2. Изложены
3. Выполнены

Само–документирующий код?

• PHP и язык не взаимозаменяемы
• документация интерфейс для мозга
• код интерфейс для компьютера

Порядок

1. Прочитать
2. Понять
3. Изменить

PSR–12

Стили кода для форматирования и привычности.

WordPress Coding Standards

Стандарты кода для правил и соглашений.

Предположение

Код это актив.

Реальность

Код это риск.

Цикломатическая сложность

Число путей в коде,
измеряет сложность тестирования.

Когнитивная сложность

Оценка сложности для человека,
измеряет сложность понимания.

История типов

1. PHP 5: класс/интерфейс, array, callable
2. PHPDoc: объединение, пересечение, скалярные...
3. PHP 7: скалярные, iterable, object
4. Psalm: сложные массивы, шаблоны
5. PHP 8: объединение

Современность

Поддержка языком, статический анализ,
высокое покрытие.

Историческое

Нет обработки исключений, небезопасные API.

Навыки тестирования

• делать хорошие тесты
• не делать плохие тесты
• делать тестируемый код
• делать код тестируемым

Миф

Тесты универсально хороши.

Правда

Плохие тесты могут быть
хуже чем никаких.

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

• составное
• контекстное
• согласуемое
• вычислительное

Пример стека

• PhpStorm (интегрированная среда разработки)
  • PHP Inspections ​EA Extended (анализ дефектов)
  • PHP_CodeSniffer, WordPress Coding Standards (стандарт кода)
    • PHPCS Cognitive Complexity (анализ сложности)
• Psalm (анализ типов)
• Scrutinizer (непрерывная интеграция, покрытие, анализ тестируемости)
  • PHPUnit (модульные тесты)
    • Brain Monkey (макеты ядра)