Copy-Paste программирование


Программирование методом копирования-вставки (copy-paste) — распространённый анти-паттерн (ловушка) при написании кода, под которым обычно понимают многократное копирование (с последующей правкой) существующего кода вместо создания общих решений. Подобный стиль программирования часто приводит к появлению избыточно больших, сложно читаемых функций, содержащих большое количество повторяющихся фрагментов кода. Подобный код сложен для восприятия, а многократно повторяющиеся фрагменты притупляют внимание программиста, что может приводить к опечаткам. Если же ошибка была допущена изначально, то она будет многократно размножена по всему коду.

Распространённость подобных ошибок (особенно в крупных проектах) зачастую объясняется практической невозможностью избежать копирования подряд нескольких строк, например при вызове одного метода с различными (но в целом прохожими) параметрами и применении такого метода к различным объектам несколько раз подряд. Причём ручная проверка такого кода (рецензирование) оказывается малоэффективна, т.к. человеческий глаз просто не заметит отличия в 1-2 символа.

Ошибки copy-paste программирования удобно выявлять ещё на этапе написания кода в автоматическом режиме, например с помощью методики статического анализа. В отличие от обычного ручного рецензирования, статический анализ обычно полностью автоматизирован и покрывает весь код проекта, даже те редко исполняемые участки, ошибки в которых трудно выявить с помощью динамических методов верификации.

Приведём несколько примеров реальных ошибок copy-paste паттерна на языке C++, найденных в известных Open-Source проектах с помощью статического анализатора PVS-Studio.

Проект Fennec Media Project. Промах при работе с элементами массива.

fhead[11] = '\0';
fhead[12] = '\0';
fhead[13] = '\0';
fhead[13] = '\0';

Четыре схожие строчки, скорее всего, появились в коде программы с помощью копирования. Затем, при правке индексов допущена ошибка, из-за которой ноль записывается в 'fhead[13] ' два раза и не записывается в 'fhead[14] '.

Проект ReactOS. Выбор неправильного объекта.

HPEN hhi = CreatePen(0, 0, MAKE_PALETTERGB(crHighlight));
HPEN hsh = CreatePen(0, 0, MAKE_PALETTERGB(crShadow));
...
if(fNormal)
  hOld = SelectObject(hdc, hhi);
else
  hOld = SelectObject(hdc, hhi);
...

Объект 'hsh' не используется. Всегда используется объект 'hhi'.

Дополнительные примеры copy-paste ошибок (и не только), обнаруженных методикой статического анализа, можно найти по этой ссылке.

В более общем случае Copy-Paste программированием также может называться использование (или адаптация) существующих сторонних решений (например, из открытых источников), часто без понимания принципов их работы. В свою очередь, это приводит к неоднородности стиля в проекте, неэффективности работы и перегруженности кода.

Библиографический список


А ты совершаешь ошибки в коде?

Проверь с помощью
PVS-Studio

Статический анализ
кода для C, C++ и C#

goto PVS-Studio;