Syntax highlighting

From Wikipedia, the free encyclopedia
Jump to: navigation, search
For syntax highlighting of source in Wikipedia and other wikis using MediaWiki, see Wikipedia:Text editor support or the Syntax Highlight Extension.
HTML syntax highlighting

Syntax highlighting is a feature of text editors that are used for programming, scripting, or markup languages, such as HTML. The feature displays text, especially source code, in different colors and fonts according to the category of terms.[1] This feature facilitates writing in a structured language such as a programming language or a markup language as both structures and syntax errors are visually distinct. Highlighting does not affect the meaning of the text itself; it is intended only for human readers.

Syntax highlighting is a form of secondary notation, since the highlights are not part of the text meaning, but serve to reinforce it. Some editors also integrate syntax highlighting with other features, such as spell checking or code folding, as aids to editing which are external to the language.

Practical considerations[edit]

Highlighting the effect of missing delimiter (after watch='false) in JavaScript

Syntax highlighting is one strategy to improve the readability and context of the text; especially for code that spans several pages. The reader can easily ignore large sections of comments or code, depending on what they are looking for. Syntax highlighting also helps programmers find errors in their program. For example, most editors highlight string literals in a different color. Consequently, spotting a missing delimiter is much easier because of the contrasting color of the text. Brace matching is another important feature with many popular editors. This makes it simple to see if a brace has been left out or locate the match of the brace the cursor is on by highlighting the pair in a different color.

Some text editors can also export the color markup in a format that is suitable for printing or for importing into word-processing or other kinds of text-formatting software; for instance an HTML, colorized LaTeX, PostScript or RTF version of its syntax highlighting.

There are several syntax highlighting libraries or "engines" that can be used in other applications, but are not complete programs in themselves, e.g., GeSHi for PHP.

Multi-document editors[edit]

For editors that support more than one language, the user can usually specify the language of the text, such as C, LaTeX, HTML, or the text editor can automatically recognize it based on the file extension or by scanning contents of the file. This automatic language detection presents potential problems. For example, a user may want to edit a document containing:

  • more than one language (for example when editing an HTML file that contains embedded JavaScript code),
  • a language that is not recognized (for example when editing source code for an obscure or relatively new programming language),
  • a language that differs from the file type (for example when editing source code in an extension-less file in an editor that uses file extensions to detect the language).

In these cases, it is not clear what language to use, and a document may not be highlighted or be highlighted incorrectly.

Syntax elements[edit]

Most editors with syntax highlighting allow different colors and text styles to be given to dozens of different lexical sub-elements of syntax. These include keywords, comments, control-flow statements, variables, and other elements. Programmers often heavily customize their settings in an attempt to show as much useful information as possible without making the code difficult to read.

Examples[edit]

Below is a comparison of a snippet of C code:

Standard rendering Syntax highlighting
/* Hello World */
#include <stdlib.h>
#include <stdio.h>

int main()
{
    printf("Hello World\n");
    return 0;
}
/* Hello World */
#include <stdlib.h>
#include <stdio.h>

int main()
{
    printf("Hello World\n");
    return 0;
}

Below is another snippet of syntax highlighted C++ code:

// Create "windowCount" Window objects:
int windowCount = 10;
Window **windows = new Window *[max];
for (int i = 0; i < windowCount; ++i) {
    windows[i] = new Window();
}

In the C++ example, the editor has recognized the keywords int, new, and for. The comment at the beginning is also highlighted in a specific manner to distinguish it from working code.

History and limitations[edit]

The ideas of syntax highlighting overlap significantly with those of syntax-directed editors. One of the first such editor for code was Wilfred Hansen's 1969 code editor, Emily.[2][3] It provided advanced language-independent code completion facilities, and unlike modern editors with syntax highlighting, actually made it impossible to create syntactically incorrect programs.

In 1985 Ben Shneiderman suggested "color coding of text strings to suggest meaning".[4] The Live Parsing Editor (LEXX) written for the VM operating system for the computerization of the Oxford English Dictionary in 1985 was one of the first to use color syntax highlighting. Its live parsing capability allowed user-supplied parsers to be added to the editor, for text, programs, data file, etc.[5] On microcomputers, MacPascal 1.0 (October 10, 1985) recognized Pascal syntax as it was typed and used font changes (e.g., bold for keywords) to highlight syntax and automatically indented code to match its structure.[6]

Many text editors and code formatting tools perform syntax highlighting using pattern matching heuristics (e.g. Regular expressions) rather than implementing a parser for each possible language[citation needed]. This can result in some text rendering systems' syntax highlighting being somewhat inaccurate and, in some cases, can perform slowly. Some text editors overcome this problem by not always parsing the whole file but rather just the visible area, sometimes scanning backwards in the text up to a limited number of lines for "syncing".

Some modern, language-specific IDEs (in contrast to text editors) perform full language parsing which results in very accurate understanding of code. An extension of syntax highlighting was called "semantic highlighting" in 2009 by David Nolden [7] for the open-source C++ IDE KDevelop. For example, semantic highlighting may give local variables unique distinct colors to improve the comprehensibility of code. In 2014 the idea of colored local variables got further popularized due to a blog post by Evan Brooks,[8] and after that, the idea was transferred to other popular IDEs like Visual Studio,[9] Xcode,[10] and others.

See also[edit]

References[edit]

  1. ^ See e.g., The Java Developer's Guide to Eclipse By Jim D'Anjou, Sherry Shavor, Scott Fairbrother, Dan Kehn, John Kellerman, Pat McCarthy Published by Addison-Wesley, 2004 ISBN 978-0-321-30502-2, 1136 pages
  2. ^ Hansen, Wilfred J. (1971). "User engineering principles for interactive systems". Proceedings of the Fall Joint Computer Conference FJCC 39. AFIPS. pp. 5623–532. 
  3. ^ Hansen, Wilfred. "Emily - An Editor for Structured Text". Retrieved 17 June 2013. 
  4. ^ Shneiderman, Ben (1985). "4.1.1.2". In H. Rex Hartson. Advances in human-computer interaction (2. print. ed.). Norwood, N.J.: Ablex. p. 122. ISBN 0893912441. 
  5. ^ Cowlishaw, M. F. (1987). "LEXX – A programmable structured editor" (PDF). IBM Journal of Research and Development, Vol 31, No. 1, IBM Reprint order number G322-0151. IBM. 
  6. ^ Allen, Dan (2011-10-10). "A Trio of Historical Recollections". mpw-dev (Mailing list). Retrieved 11 March 2012. 
  7. ^ "2009 blog post on Semantic Highlighting introduced in KDevelop by David Nolden". 
  8. ^ "2014 blog post on Semantic Highlighting by Evan Brooks". 
  9. ^ "Visual Studio Magazine article on semantic highlighting". 
  10. ^ "Github page of a plugin which implements semantic highlighting for Xcode".