Программирование копирования и вставки - Copy-and-paste programming

Программирование копирования и вставки, иногда называемый просто оклейка, это производство часто повторяющихся компьютерное программирование код, созданный скопировать и вставить операции. Это прежде всего уничижительный термин; Те, кто использует этот термин, часто подразумевают отсутствие навыков программирования. Это также может быть результатом технологических ограничений (например, недостаточно выразительной среды разработки), поскольку вместо этого обычно используются подпрограммы или библиотеки. Однако бывают случаи, когда программирование копирования и вставки считается приемлемым или необходимым, например, для шаблон, разворачивание петли (когда не поддерживается автоматически компилятором) или некоторыми идиомами программирования, и он поддерживается некоторыми редакторы исходного кода в виде фрагменты.

Происхождение

Программирование методом копирования и вставки часто выполняется неопытными программистами или студентами, которые считают процесс написания кода с нуля трудным или раздражающим и предпочитают искать заранее написанное решение или частичное решение, которое они могут использовать в качестве основы для своей собственной проблемы. решение.[1](Смотрите также Культ карго )

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

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

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

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

Дублирование

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

Применение кода библиотеки

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

Будучи формой дублирование кода, программирование копирования и вставки имеет некоторые внутренние проблемы; такие проблемы усугубляются, если код не сохраняет семантическую связь между исходным текстом и копиями. В этом случае, если необходимы изменения, время тратится на поиск всех повторяющихся местоположений. (Это может быть частично смягчено, если исходный код и / или копия правильно прокомментированы; однако даже в этом случае остается проблема внесения одних и тех же изменений несколько раз. Кроме того, поскольку при обслуживании кода часто не обновляются комментарии,[3] комментарии, описывающие, где найти удаленные фрагменты кода, печально известны тем, что они устарели.)

Сторонники объектно-ориентированный Методологии также возражают против использования «библиотеки кода» копирования и вставки. Вместо создания нескольких измененных копий общего алгоритма объектно-ориентированный подход Абстрактные алгоритм в многоразовый инкапсулированный учебный класс. Класс написан гибко, с полной поддержкой наследование и перегрузка, чтобы весь вызывающий код можно было связать с прямым использованием этого универсального кода, а не изменять исходный.[4] Поскольку требуется дополнительная функциональность, библиотека расширяется (при сохранении Обратная совместимость ). Таким образом, если в исходном алгоритме есть ошибка, которую нужно исправить или можно улучшить, все программное обеспечение, использующее его, получит выгоду.

Код ветвления

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

  • Управляется управление версиями система, поддерживающая ветвление
  • Филиалы повторно объединяются после завершения параллельной разработки.

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

Как способ создания нового продукта, программирование копирования и вставки имеет некоторые преимущества. Поскольку новая инициатива разработки не затрагивает код существующего продукта:

  • Нет необходимости регрессионный тест существующий продукт, экономя время QA, связанное с запуском нового продукта, и сокращая пора торговать.
  • Отсутствует риск появления ошибок в существующем продукте, которые могли бы расстроить установленную базу пользователей.

Минусы:

  • Если новый продукт не так сильно отличается от существующего продукта, как ожидалось, может потребоваться поддержка двух кодовых баз (с удвоенной стоимостью) вместо одной. Это может привести к дорогостоящим рефакторинг и ручное слияние по линии.
  • В повторяющийся код base удваивает время, необходимое для внесения изменений, которые могут потребоваться для обоих продуктов; это увеличивается время вывода на рынок таких изменений и может фактически свести на нет выигрыш во времени, достигнутый в первую очередь за счет разветвления кода.

Как и в предыдущем случае, альтернативой подходу копирования и вставки может быть модульный подход:

  • Начните с вынесения кода, который будет использоваться обоими продуктами, в библиотеки.
  • Используйте эти библиотеки (а не вторую копию базы кода) в качестве основы для разработки нового продукта.
  • Если в будущем предусмотрена дополнительная третья, четвертая или пятая версия продукта, этот подход будет намного сильнее, потому что готовые библиотеки кода значительно сокращают жизненный цикл разработки любых дополнительных продуктов после второй.[5]

Повторяющиеся задачи или вариации задачи

Сложность и риск поддержки кода, написанного методом копирования и вставки

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

  • Подход копирования и вставки часто приводит к большим методам (плохой запах кода ).
  • Каждый экземпляр создает дубликат кода со всеми проблемами, описанными в предыдущих разделах, но с гораздо большей областью действия. Множество дублирований - обычное явление; возможны сотни. В частности, исправление ошибок в таком коде становится очень сложным и дорогостоящим.[6]
  • Такой код также страдает от серьезных проблем с читабельностью из-за трудности точного определения различий между каждым повторением. Это напрямую влияет на риски и затраты на пересмотр кода.
  • В процедурное программирование Модель категорически не рекомендует использовать метод копирования и вставки для повторяющихся задач. В рамках процедурной модели предпочтительным подходом к повторяющимся задачам является создание функции или подпрограммы, которая выполняет один проход через задачу; затем эта подпрограмма вызывается родительской подпрограммой либо повторно, либо, что еще лучше, с некоторой формой циклической структуры. Такой код называется «хорошо разложенным», и рекомендуется, чтобы он был более легким для чтения и более легко расширяемым.[7]
  • Генерал практическое правило применимо к этому делу "не повторяйся ".

Осознанный выбор дизайна

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

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

В Язык программирования подтекста это исследовательский проект, направленный на «декриминализацию» вырезок и вставок. Используя этот язык, вырезать и вставить является основной моделью взаимодействия и, следовательно, не считается антипаттерном.

Пример

Простым примером является цикл for, который можно выразить как за (int я=0; я!=п; ++я) {}.

Пример кода, использующего такой цикл for, может быть следующим:

пустота фу(int п) {    за (int я=0; я!=п; ++я) {       /* тело */    }}

Затем код цикла мог быть сгенерирован с помощью следующего фрагмента (с указанием типов и имен переменных):

    за ($тип $loop_var = 0; $loop_var != $остановка; ++$loop_var) {        /* тело */    }

Смотрите также

Рекомендации

  1. ^ а б «Пересмотр ошибок начинающих программистов». acm.org. Получено 2008-06-04.
  2. ^ «Динамическое построение веб-страниц ASP.NET в программном обеспечении». codeproject.com. Получено 2008-06-04.
  3. ^ Спинеллис, Диомидис. "Руководство по выявлению плохого кода". InformIT.com. Получено 2008-06-06.
  4. ^ Льюаллен, Раймонд. «4 основных принципа объектно-ориентированного программирования». codebetter.com. Архивировано из оригинал на 25.11.2010. Получено 2008-06-04.
  5. ^ Эриксен, Лиза. «Повторное использование кода при разработке объектно-ориентированного программного обеспечения» (PDF). Норвежский университет науки и технологий, факультет компьютерных и информационных наук. Получено 2008-05-29.
  6. ^ Эшли Марш. «Стандарты кодирования - путь к поддержанию кода». MAAN Softwares INC. Получено 2018-04-10.
  7. ^ "Стэнфордский университет, CS 106X (" Программирование абстракций ") Раздаточный материал:" Декомпозиция"" (PDF). Стэндфордский Университет. Архивировано из оригинал (PDF) 16 мая 2008 г.. Получено 2008-06-04.

внешняя ссылка