Сворачивание кода - Code folding

Не путать с Постоянное сворачивание.
Пример сворачивания кода на PHP с vim.

Сворачивание кода это особенность некоторых текстовые редакторы, редакторы исходного кода, и Иды это позволяет пользователю выборочно скрывать и отображать - «сворачивать» - разделы редактируемого в данный момент файла как часть обычных операций редактирования. Это позволяет пользователю управлять большими объемами текста, просматривая только те части текста, которые особенно актуальны в любой момент времени.

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

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

Сворачивание текста аналогичная функция используется в складные редакторы, планировщики, и немного текстовые процессоры, но используется для обычного текста и, если он выполняется автоматически, основан на синтаксисе человеческих языков, в частности на уровне абзацев или разделов, а не на синтаксисе компьютерного языка. Другой вариант сворачивания кода - "сворачивание данных", которое реализовано в некоторых шестнадцатеричные редакторы и используется для структурирования двоичного файла или скрытия недоступных разделов данных в редакторе RAM.[1] Существуют различные альтернативные термины для таких функций, в том числе «развернуть и свернуть», «скрыть код» и «очертить». В слове Microsoft эта функция называется «разборная структура».

История

Самый ранний известный пример сворачивания кода в редакторе находится в NLS (компьютерная система).[2] Вероятно, первым широко доступным редактором фальцовки был редактор SPF 1974 года для мэйнфреймов IBM 370, который мог скрывать строки на основе их отступов. Он отображается на 3270 терминалах с отображением символов.[3] Это было очень полезно для многословных языков, таких как КОБОЛ. Он превратился в средство повышения производительности интерактивной системы (ISPF ).

Использовать

Сворачивание кода имеет различные использовать шаблоны, в первую очередь упорядочивая код или скрывая менее полезную информацию, чтобы можно было сосредоточиться на более важной информации. Далее следуют общие шаблоны.[4]

Обрисовка

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

Скрытие шаблонного кода

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

Например, в Java для одного частного поля с геттером и сеттером требуется как минимум 3 строки, если каждая находится в отдельной строке:

частный Нить имя = ноль;общественный Нить getName() { возвращаться имя; }общественный пустота Имя набора(Нить имя) { это.имя = имя; }

Это расширяется до 10 строк с обычными разрывами строк функций и интервалом между функциями (включая завершающую новую строку):

частный Нить имя = ноль;общественный Нить getName() {    возвращаться имя;}общественный пустота Имя набора(Нить имя) {    это.имя = имя;}

Документация с Javadoc расширяет это до 20 строк:

/** * Свойство  name  доступно для чтения / записи. */частный Нить имя = ноль;/** * Получатель для свойства  name  */общественный Нить getName() {    возвращаться имя;}/** * Установщик для свойства  name . * @ имя параметра */общественный пустота Имя набора(Нить имя) {    это.имя = имя;}

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

Сворачивание метаданных

Метаданные могут быть длинными и, как правило, менее важны, чем данные, которые они описывают. Сворачивание метаданных позволяет в первую очередь сосредоточиться на данных, а не на метаданных. Например, длинный список атрибутов в C # может быть свернут вручную следующим образом:[5]

#region Attributes[Доступен для просмотра (ложь)][MergableProperty (false)][DefaultValue (null)][PersistenceMode (PersistenceMode.InnerProperty)][TemplateContainer (typeof (MyType))][TemplateInstance (TemplateInstance.Single)] #endregionобщественный ITemplate ContentTemplate{    получать { возвращаться _temp; }    набор { _temp = ценить; }}

Результирующий код отображается как:

Атрибутыобщедоступный ITemplate ContentTemplate {получить {return _temp; } установить {_temp = значение; }}

Сворачивание комментариев

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

Отображение структурного или сэндвич-кода в структурированном программировании

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

Код группировки

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

Скрытие устаревшего кода

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

Скрытие таблиц исходных данных

Конвенции

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

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

Зависит от синтаксиса

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

На основе отступов

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

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

На основе токенов

Точки сворачивания на основе токенов указываются с помощью специальных разделители которые не служат никакой другой цели в тексте, кроме определения границ точек изгиба. Это соглашение можно сравнить с точками сворачивания на основе отступов, где вместо пробелов используются печатаемые символы. Наиболее распространенные токены-разделители: {{{ чтобы начать сложенную секцию, и }}} чтобы положить этому конец.

Еще один примечательный токен #область, край (Директивы C # ), соответственно #Область, край (Директивы Visual Basic ), используется в Microsoft Visual Studio Редактор кода. Они обрабатываются синтаксически как директивы компилятора, хотя они не влияют на компиляцию.

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

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

Указано пользователем

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

Примеры

Следующий документ содержит складные токены ({{{ ... }}}):

 Заголовок 1 {{{Body}}} Заголовок 2 {{{Body}}} Заголовок 3 {{{Body}}}

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

 Заголовок 1 {{{... Заголовок 2 {{{... Заголовок 3 {{{...

Обычно нажимая на {{{ отмечает, что появляется соответствующий основной текст.

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

Одним из первых редакторов-фальцовщиков был STET, редактор, написанный для ВМ / CMS операционной системы в 1977 г. Майк Коулишоу. STET - текстовый редактор (для документации, программ и т. Д.), Который сворачивает файлы на основе блоков строк; любой блок линий можно сложить и заменить линией имени (которая, в свою очередь, может быть частью блока, который затем может быть свернут).

Редактор фальцовки появился в Оккам IDE около 1983 г., который назывался Система транспьютерной разработки Inmos (TDS)[6],.[7] Редактор "f" (в списке ниже), вероятно, является наиболее сохранившимся наследием этой работы.

В Macintosh компьютер исторически имел ряд редакторы исходного кода что "свернутые" части кода через "раскрытие треугольники ». Программное обеспечение UserLand product Frontier - это среда сценариев, которая имеет такую ​​возможность.[8]

Фальцовка обеспечивается многими современными текстовыми редакторами, и основанный на синтаксисе или сворачивание на основе семантики теперь является компонентом многих среды разработки программного обеспечения. Редакторы включают:

ИмяТокенОтступСинтаксисПользователь
Редактор ABAPда?да?
АкельПад??да?
Анджута IDE?дада?
Атом[а]?да?да
BBEdit??да?
СкобкиПлагиндадаНет
Codeanywhereдадада?
Codenvyдадада?
Code :: Blocks IDEдададада
CudaText????
IDE Delphiда?да?
Dreamweaver???да
Затмение??да?
EditPlusНетдаНетНет
Emacsда[b]?[c]да[d]да[e]
EmEditor Professional?дада?
FlashDevelop IDE??да?
geany??да?
geditдадада?
ISPF?да?да
JEDдада[f]?Нет
jEditдададада
Катядададада
MATLABНетНетдаНет
MS Visual Studioдададада
IDE NetBeansдададада
Блокнот ++?дадада
NuSphere PHPEd??дада
Qt Creator??да?
НАУКАдадада?
STET[грамм]????
TextMateдададада
UltraEditНетНетдада
Vimдададада
Визуальный эксперт??да?
Код Visual StudioдададаНет
Xcodeдададада
Zend Studio????


Другие редакторы

Примечания

  1. ^ http://flight-manual.atom.io/using-atom/sections/folding/
  2. ^ Сворачивание на основе токенов реализуется складывание второстепенный режим. Также можно использовать контур и все вон второстепенные режимы для разделения исходных текстов программ.
  3. ^ Можно использовать выборочный дисплей в Emacs, чтобы скрыть строки в зависимости от уровня отступа, как это предлагается в Универсальное сворачивание кода Примечание.
  4. ^ Сворачивание в зависимости от синтаксиса поддерживается контур и все вон режимы для специальных контур -синтаксисы; посредством скрыть шоу второстепенный режим для некоторых языков программирования; также, по сворачивание семантических тегов второстепенный режим и сенатор команда для синтаксисы, поддерживаемые семантический (компонент CEDET), а также doc-режим за JavaDoc или же Doxygen комментарии, автор TeX-свернутый режим, sgml-складной элемент команда nxml-outln библиотека в соответствующих языковых режимах и, возможно, в других режимах для определенных синтаксисов. Иногда стандартный простой контур второстепенный режим используется для имитации сворачивания на основе синтаксиса, ср. то использовать в исходном коде Emacs Lisp с правильным отступом, его использование (см. в конце страницы) для HTML с правильным отступом. Несколько механизмов складывания объединены складной интерфейс. Смотрите также КатегорияСкрыть.
  5. ^ Сворачивание выбранных пользователем регионов в Emacs осуществляется скрыть-регион-скрыть команда.
  6. ^ В set_selective_display Функция может использоваться, чтобы скрыть строки с отступом сверх указанного значения.
  7. ^ STET, возможно, был первым текстовым редактором, который поддерживал складывание[нужна цитата ]

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

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

  1. ^ «Сворачивание данных в шестнадцатеричном редакторе HxD (перечислено как функция RAM-Editor)». Получено 2007-04-30.
  2. ^ Мать всех демосов, представленная Дугласом Энгельбартом (1968), получено 2019-12-29
  3. ^ «История ISPF». Получено 2015-10-27.
  4. ^ Этвуд 2008.
  5. ^ Сообщение # 31, Роб, июль 2008 г.
  6. ^ Североамериканская группа пользователей транспьютеров. Конференция (2-я: 1989: Дарем, Северная Каролина) (1990). Транспьютерные исследования и приложения, 2: NATUG-2, материалы Второй конференции Североамериканской группы пользователей транспьютеров, 18-19 октября 1989 г., Дарем, Северная Каролина.. Правление, Джон А., Университет Дьюка. Амстердам: IOS Press. п. 85. ISBN  9051990278. OCLC  35478471.
  7. ^ Корми, Дэвид (1986). «Техническая записка INMOS 03 - Начало работы с TDS» (PDF). transputer.net. Получено 2019-07-19.
  8. ^ "Outliners.com". Архивировано из оригинал на 2006-12-23. Получено 2006-12-27.
  9. ^ LEXX - программируемый структурированный редактор Журнал исследований и разработок IBM, Том 31, № 1, 1987, номер заказа на переиздание IBM G322-0151

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