Складывание кода

Не путать с постоянным складыванием .

Пример свертывания кода PHP- кода с помощью Vim

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

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

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

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

Свертывание данных встречается в некоторых шестнадцатеричных редакторах и используется для структурирования двоичного файла или сокрытия недоступных разделов данных.

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

История

Самый ранний известный пример свертывания кода в редакторе — NLS . Вероятно, первым широко доступным складным редактором был редактор Structured Programming Facility (SPF) 1974 года для мэйнфреймов IBM 370 , который мог скрывать строки в зависимости от их отступов. Он отображается на терминалах 3270 с символьным отображением. Это было очень полезно для таких многословных языков, как COBOL . Он превратился в Центр повышения производительности интерактивных систем ( ISPF ).

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

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

Изложение

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

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

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

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

private String name = null;
public String getName() { return name; }
public void setName(String name) { this.name = name; }

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

private String name = null;

public String getName() {
    return name;
}

public void setName(String name) {
    this.name = name;
}

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

/**
 * Property <code>name</code>  readable/writable.
 */
private String name = null;

/**
 * Getter for property <code>name</code>
 */
public String getName() {
    return name;
}

/**
 * Setter for property <code>name</code>.
 * @param name
 */
public void setName(String name) {
    this.name = name;
}

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

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

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

#region Attributes
[Browsable(false)]
[MergableProperty(false)]
[DefaultValue(null)]
[PersistenceMode(PersistenceMode.InnerProperty)]
[TemplateContainer(typeof(MyType))]
[TemplateInstance(TemplateInstance.Single)] 
#endregion
public ITemplate ContentTemplate { get; set; }

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

Attributes
public ITemplate ContentTemplate { get; set; }

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

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

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

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

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

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

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

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

Конвенции

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

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

Синтаксис-зависимый

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

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

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

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

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

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

Еще одним примечательным признаком является #region ( директивы C# ), соответственно #Region ( директивы Visual Basic ), используемые в Microsoft Visual Studio редакторе кода . Синтаксически они рассматриваются как директивы компилятора , но не влияют на компиляцию.

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

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

Определяется пользователем

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

Примеры

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

 Heading 1
 {{{
 Body
 }}}

 Heading 2
 {{{
 Body
 }}}

 Heading 3
 {{{
 Body
 }}}

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

 Heading 1
 {{{ ...

 Heading 2
 {{{ ...

 Heading 3
 {{{ ...

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

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

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

появился складной редактор 1983 году в occam IDE Примерно в , который назывался Inmos Transputer Development System (TDS). ^, . Редактор «f» (в списке ниже), вероятно, является наиболее нетронутым наследием этой работы.

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

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

Имя	Токен	Отступ	Синтаксис	Пользователь
ABAP-редактор	Да	?	Да	?
SinglePad	?	?	Да	?
Анюта ИДЕТ	?	Да	Да	?
Атом	?	Да	?	Да
BBEредактировать	?	?	Да	?
Кронштейны	Плагин	Да	Да	Нет
Коденигде	Да	Да	Да	?
Коденви	Да	Да	Да	?
Код::Блокирует IDE	Да	Да	Да	Да
Кубическая IDE	Да	Да	Да	Да
КудаТекст	?	?	?	?
Делфи IDE	Да	?	Да	?
Ткач снов	?	?	?	Да
Затмение	?	?	Да	?
EditPlus	Нет	Да	Нет	Нет
Эмакс	Да	?	Да	Да
EmEditor Профессиональный	?	Да	Да	?
FlashDevelop IDE	?	?	Да	?
гени	?	Да	Да	?
гедит	Да	Да	Да	?
ISPF	?	Да	?	Да
ДЖЕД	Да	Да	?	Нет
jПравить	Да	Да	Да	Да
Кейт	Да	Да	Да	Да
МАТЛАБ	Нет	Нет	Да	Нет
MS Visual Studio	Да	Да	Да	Да
NetBeans IDE	Да	Да	Да	Да
Блокнот++	?	Да	Да	Да
Нусфера PHPEd	?	?	Да	Да
Создатель Qt	?	?	Да	?
Ты знаешь	Да	Да	Да	?
СТОЯТЬ	?	?	?	?
ТекстМейт	Да	Да	Да	Да
УльтраПравить	Нет	Нет	Да	Да
Почему	Да	Да	Да	Да
Визуальный эксперт	?	?	Да	?
Код Visual Studio	Да	Да	Да	Нет
Xcode	Да	Да	Да	Да
Отправить студию	?	?	?	?

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

• aoeui, оптимизированный для Дворжака редактор
• Корпоративное программное обеспечение для авторской разработки и управления компонентным контентом Author-it
• f (псевдоним xf, Winf, Winf32)
• Складной текстовый редактор
• БАЗОВЫЙ ГФА
• GridinSoft Блокнот
• IntelliJ IDEA (и другие JetBrains ) IDE
• Основной доклад
• Комодо Править
• Написать
• Лео
• LEXX/LPEX (редактор OED )
• МоноРазвитие
• ПримечаниеТаб Про
• Отец
• Текстовый редактор RJ
• Дикая клубника
• Редактор журнала «Хесслинг»
• Визуальная Студия
• WinShell (начиная с версии 3.30)
• XEDIT (однако его свертывание осуществляется скриптами)
• Зевс

См. также

• статьи «Возможности программирования» В разделе «Сравнение текстовых редакторов» вы найдете больше редакторов, поддерживающих свертывание.
• Аккордеон (GUI) — аналогичный метод пользовательского интерфейса, применяемый к иерархическим спискам, а не к тексту.

Ссылки

• Этвуд, Джефф (6 июля 2008 г.). «Проблема со свертыванием кода» . Coding Horror — критика свертки кода, подробные комментарии по использованию. {{cite web}}: CS1 maint: постскриптум ( ссылка )

Внешние ссылки

• Что такое складной редактор? от автора fe редактор.
• Описание складного редактора, используемого в occam .