Code ortext folding, or less commonlyholophrasting,^[1] is a feature of somegraphical user interfaces that allows the user to selectively hide ("fold") or display ("unfold") parts of a document. This allows the user to manage large amounts of text while viewing only those subsections that are currently of interest. It is typically used with documents which have a naturaltree structure consisting of nested elements. Other names for these features includeexpand and collapse,code hiding, andoutlining. InMicrosoft Word, the feature is called "collapsible outlining".

Many user interfaces providedisclosure widgets for code folding in a sidebar, indicated for example by a triangle that points sideways (if collapsed) or down (if expanded), or by a[-] box for collapsible (expanded) text, and a[+] box for expandable (collapsed) text.

Code folding is found intext editors,source code editors, andIDEs. The folding structure typically follows thesyntax tree of the program defined by thecomputer language. It may also be defined by levels ofindentation, or be specified explicitly using an in-band marker (saved as part of the source code) or out-of-band.

Text folding is a similar feature used on ordinary text, where the nested elements consist of paragraphs, sections, oroutline levels. Programs offering this includefolding editors,outliners, and someword processors.

Data folding is found in somehex editors and is used to structure a binary file or hide inaccessible data sections.^[2]

Folding is also frequently used indata comparison, to select one version or another, or only the differences.

The earliest known example of code folding in an editor is inNLS.^[3] Probably the first widely available folding editor was the 1974 Structured Programming Facility (SPF) editor forIBM 370 mainframes, which could hide lines based on their indentation. It displayed on character-mapped 3270 terminals.^[4] It was very useful for prolix languages likeCOBOL. It evolved into the Interactive System Productivity Facility (ISPF).

Code folding has varioususe patterns, primarily organizing code or hiding less useful information so one can focus on more important information. Common patterns follow.^[5]

Most basically, applications use code folding to outline source code, collapsing each block to a single line. This can be only top-level blocks like functions and classes, nested blocks like nested functions and methods, or all blocks, notably control-flow blocks. This allows one to get an overview of code, easily navigating and rearranging it, and to drill down into more detail as needed, without being distracted by other code. Viewing-wise, this allows one to quickly see a list of all functions (without their bodies), while navigation-wise this replaces extensive paging past long functions – or searching for the target – with going directly to the next function.

Some languages or libraries require extensiveboilerplate code. This results in extremely long code, which can obscure the main point. Further, substantive code can be lost in the boilerplate.

For example, in Java a single private field with a getter and setter requires at least 3 lines, if each is on a separate line:

privateStringname=null;publicStringgetName(){returnname;}publicvoidsetName(Stringname){this.name=name;}

This expands to 10 lines with conventional function line breaks and spacing between functions (including trailing newline):

privateStringname=null;publicStringgetName(){returnname;}publicvoidsetName(Stringname){this.name=name;}

Documentation with Javadoc expands this to 20 lines:

/** * Property <code>name</code>  readable/writable. */privateStringname=null;/** * Getter for property <code>name</code> */publicStringgetName(){returnname;}/** * Setter for property <code>name</code>. * @param name */publicvoidsetName(Stringname){this.name=name;}

If there are many such fields, the result can easily be hundreds of lines of code with very little "interesting" content – code folding can reduce this to a single line per field, or even to a single line for all fields. Further, if all routine fields are folded, but non-routine fields (where getter or setter is not just returning or assigning a private field) are not folded, it becomes easier to see the substantive code.

Metadata can be lengthy, and is generally less important than the data it is describing. Collapsing metadata allows one to primarily focus on the data, not the metadata. For example, a long list ofattributes inC# may be manually collapsed as follows:^[6]

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

The resulting code displays as:

AttributespublicITemplateContentTemplate{get;set;}

Comments are a form of human-readable metadata, and lengthy comments can disrupt the flow of code. This can be the case either for a long comment for a short section of code, such as a paragraph to explain one line, or comments fordocumentation generators, such asJavadoc orXML Documentation. Code folding allows one to have long comments, but to display them only when required. In cases where a long comment has a single summary line, such as Python docstrings, the summary can still be displayed when the section is collapsed, allowing a summary/detailed view.

Structured programming consists of nested blocks of code, and long blocks of code – such as long switch statements – can obscure the overall structure. Code folding allows one to see the overall structure and expand to a specific level. Further, in some uses, particularly strict structured programming (single function exit), there are code patterns that are hard to see when looking at expanded code. For example, inresource management in structured programming, one generally acquires a resource, followed by a block of code using the resource, and finishing with releasing the resource. The acquisition/release pairing is hard to see if there is a long block of code in between, but easy to see if the intervening block is folded. Similarly, in conditional code likeif...then...else, secondary blocks may be far from the condition statement.

Fold groups can be used to group code, either by explicit grouping – similar to comment blocks separating a module into sections, or class members into associated groups – or implicitly, such as by automatically grouping class members by access level.

Legacy code – or any code that a developer does not wish to view or change at a given point in time – can be folded away so that programmers can concentrate on the code under consideration.

In order to support code folding, the text editor must provide a mechanism for identifying "folding points" within a text file. Some text editors provide this mechanism automatically, while others provide defaults that can either be overridden or augmented by the user.

There are various mechanisms, coarsely divided as automatic and manual – do they require any specification by the programmer? Folding points are usually determined with one or more of the following mechanisms. Each of these has its own distinct advantages and difficulties, and it is essentially up to the developers who create the text editor software to decide which to implement. Text editors that provide support for multiple folding mechanisms typically allow the user to choose which is most appropriate for the file being edited.

Syntax-dependent folding points are those that rely on the content of the file being edited in order to specify where specific folding regions should begin and end. Syntax-based folding points are typically defined around any or all of the standard sub-features of themarkup language orprogramming language in use. These are desirable due to being automatic and agreeing with code structure, but may require significant work to implement, and time to compute when editing a file.

Indentation-based folding points are generally specified by the position and sequence of non-printing whitespace, such as tabs and spaces, within the text. This is most often used as a simple form of syntax-based folding, as indentation almost always reflects nesting level inindent styles for structured programming languages.

This convention is particularly suitable to syntaxes that have anoff-side rule, so the structure largely agrees with the indent. Examples includePython and text files that require indentation as a rule by themselves. However, even in these cases, structure does not exactly agree with indent, such as inline continuation, and thus syntax-dependent folding is preferred.

Token-based folding points are specified using specialdelimiters that serve no other purpose in the text than to identify the boundaries of folding points. This convention can be compared to indentation-based folding points, where printable characters are used instead of whitespace. The most common delimiter tokens are{{{ to begin the folded section, and}}} to end it.

Another notable token is#region (C# directives), respectively#Region (Visual Basic directives), used inMicrosoft Visual StudioCode Editor. These are treated syntactically ascompiler directives, though they do not affect compilation.

As a manual method, token-based folding allows discretion in grouping code based on arbitrary criteria, such as "functions related to a given task", which cannot be inferred from syntactic analysis.

Token-based folding requires in-band signalling, with folding tokens essentially being structured comments, and unlike other methods, are present in the source code and visible to other programmers. This allows them to be shared, but also requires their use (or preservation) by all programmers working on a particular file, and can cause friction and maintenance burden.

User-specified folding allows the user to fold sections of text using a generic selection method, but without changing the source code (out-of-band), instead being specified only in the editor. For example, a programmer may select some lines of text and specify that they should be folded. Folded text might be anonymous or named, and this may be preserved across editing sessions or discarded. Unlike token-based folding, this does not change the source text – it thus is not shared with other editors of the file, and is not visible in the code.

The following document contains folding tokens ({{{ ... }}}):

 Heading 1 {{{ Body }}} Heading 2 {{{ Body }}} Heading 3 {{{ Body }}}

When loaded into a folding editor, the outline structure will be shown:

 Heading 1 {{{ ... Heading 2 {{{ ... Heading 3 {{{ ...

Usually clicking on the{{{ marks makes the appropriate body text appear.

One of the earliest folding editors wasSTET, an editor written for theVM/CMS operating system in 1977 byMike Cowlishaw. STET is a text editor (for documentation, programs, etc.) which folds files on the basis of blocks of lines; any block of lines can be folded and replaced by a name line (which in turn can be part of a block which itself can then be folded).

A folding editor appeared in theoccamIDEcirca 1983, which was called theInmos Transputer Development System (TDS)^[7],.^[8] The "f" editor (in list below) probably is the most intact legacy from this work.

TheMacintosh computer historically had a number ofsource code editors that "folded" portions of code via "disclosure triangles". TheUserLand Software product Frontier is a scripting environment that has this capability.^[9]

Folding is provided by many modern text editors, andsyntax-based or semantics-based folding is now a component of manysoftware development environments. Editors include:

• TheProgramming features section of theComparison of text editors article for more editors that support folding
• Accordion (GUI), a similar UI technique applied to hierarchical lists rather than text

Wikimedia Commons has media related toCode folding.

• What is a folding editor? by the author of thefe editor.
• Description of the folding editor used inoccam.

• Source code
• Text editor features

• All articles with unsourced statements
• Articles with unsourced statements from January 2008
• CS1 maint: numeric names: authors list
• Articles with short description
• Short description matches Wikidata
• CS1 maint: postscript
• Commons category link from Wikidata
• Articles with example C Sharp code