Hungarian notation explained

Hungarian notation is an identifier naming convention in computer programming in which the name of a variable or function indicates its intention or kind, or in some dialects, its type. The original Hungarian notation uses only intention or kind in its naming convention and is sometimes called Apps Hungarian as it became popular in the Microsoft Apps division in the development of Microsoft Office applications. When the Microsoft Windows division adopted the naming convention, they based it on the actual data type, and this convention became widely spread through the Windows API; this is sometimes called Systems Hungarian notation.

Hungarian notation was designed to be language-independent, and found its first major use with the BCPL programming language. Because BCPL has no data types other than the machine word, nothing in the language itself helps a programmer remember variables' types. Hungarian notation aims to remedy this by providing the programmer with explicit knowledge of each variable's data type.

In Hungarian notation, a variable name starts with a group of lower-case letters which are mnemonics for the type or purpose of that variable, followed by whatever name the programmer has chosen; this last part is sometimes distinguished as the given name. The first character of the given name can be capitalized to separate it from the type indicators (see also CamelCase). Otherwise the case of this character denotes scope.

History

The original Hungarian notation was invented by Charles Simonyi, a programmer who worked at Xerox PARC circa 1972–1981, and who later became Chief Architect at Microsoft. The name of the notation is a reference to Simonyi's nation of origin, and also, according to Andy Hertzfeld, because it made programs "look like they were written in some inscrutable foreign language".[1] Hungarian people's names are "reversed" compared to most other European names; the family name precedes the given name. For example, the anglicized name "Charles Simonyi" in Hungarian was originally "Simonyi Károly". In the same way, the type name precedes the "given name" in Hungarian notation. The similar Smalltalk "type last" naming style (e.g. aPoint and lastPoint) was common at Xerox PARC during Simonyi's tenure there.

Simonyi's paper on the notation referred to prefixes used to indicate the "type" of information being stored. His proposal was largely concerned with decorating identifier names based upon the semantic information of what they store (in other words, the variable's purpose). Simonyi's notation came to be called Apps Hungarian, since the convention was used in the applications division of Microsoft. Systems Hungarian developed later in the Microsoft Windows development team. Apps Hungarian is not entirely distinct from what became known as Systems Hungarian, as some of Simonyi's suggested prefixes contain little or no semantic information (see below for examples).

Systems Hungarian vs. Apps Hungarian

Where Systems notation and Apps notation differ is in the purpose of the prefixes.

In Systems Hungarian notation, the prefix encodes the actual data type of the variable. For example:

Apps Hungarian notation strives to encode the logical data type rather than the physical data type; in this way, it gives a hint as to what the variable's purpose is, or what it represents.

Most, but not all, of the prefixes Simonyi suggested are semantic in nature. To modern eyes, some prefixes seem to represent physical data types, such as sz for strings. However, such prefixes were still semantic, as Simonyi intended Hungarian notation for languages whose type systems could not distinguish some data types that modern languages take for granted.

The following are examples from the original paper:[2]

While the notation always uses initial lower-case letters as mnemonics, it does not prescribe the mnemonics themselves. There are several widely used conventions (see examples below), but any set of letters can be used, as long as they are consistent within a given body of code.

It is possible for code using Apps Hungarian notation to sometimes contain Systems Hungarian when describing variables that are defined solely in terms of their type.

Relation to sigils

In some programming languages, a similar notation now called sigils is built into the language and enforced by the compiler. For example, in some forms of BASIC, name$ names a string and count% names an integer. The major difference between Hungarian notation and sigils is that sigils declare the type of the variable in the language, whereas Hungarian notation is purely a naming scheme with no effect on the machine interpretation of the program text.

Examples

The mnemonics for pointers and arrays, which are not actual data types, are usually followed by the type of the data element itself:

While Hungarian notation can be applied to any programming language and environment, it was widely adopted by Microsoft for use with the C language, in particular for Microsoft Windows, and its use remains largely confined to that area. In particular, use of Hungarian notation was widely evangelized by Charles Petzold's "Programming Windows", the original (and for many readers, the definitive) book on Windows API programming. Thus, many commonly seen constructs of Hungarian notation are specific to Windows:

The notation is sometimes extended in C++ to include the scope of a variable, optionally separated by an underscore.[3] [4] This extension is often also used without the Hungarian type-specification:

In JavaScript code using jQuery, a $ prefix is often used to indicate that a variable holds a jQuery object (versus a plain DOM object or some other value).[5]

Advantages

(Some of these apply to Systems Hungarian only.)

Supporters argue that the benefits of Hungarian Notation include:

Disadvantages

Most arguments against Hungarian notation are against Systems Hungarian notation, not Apps Hungarian notation. Some potential issues are:

Notable opinions

See also

External links

Notes and References

  1. News: Rosenberg . Scott . Anything You Can Do, I Can Do Meta . 21 July 2022 . MIT Technology Review . 1 January 2007 . en.
  2. Web site: Charles Simonyi . Hungarian Notation . November 1999 . . MSDN Library . Charles Simonyi.
  3. Web site: Mozilla Coding Style. Developer.mozilla.org. 17 March 2015. 2 December 2019. https://web.archive.org/web/20191202222313/https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Coding_Style#Prefixes. dead.
  4. Web site: Webkit Coding Style Guidelines. Webkit.org. 17 March 2015.
  5. Web site: Why would a JavaScript variable start with a dollar sign?. Stack Overflow. 12 February 2016.
  6. Book: Jones , Derek M. . The New C Standard: A Cultural and Economic Commentary. https://web.archive.org/web/20110501142254/http://www.coding-guidelines.com/cbook/cbook1_2.pdf . 2011-05-01 . live. 727. 2009. Addison-Wesley. 978-0-201-70917-9.
  7. Web site: Make an app for any task - FileMaker — An Apple Subsidiary. Filemaker.com. 5 August 2018.
  8. Book: Martin, Robert Cecil . 2008 . Clean Code: A Handbook of Agile Software Craftsmanship . Redmond, WA . Prentice Hall PTR . 978-0-13-235088-4.
  9. Web site: Linux kernel coding style . Linux kernel documentation . 9 March 2018.
  10. Book: McConnell, Steve . Steve McConnell . 2004 . . 2nd . Redmond, WA . . 0-7356-1967-0.
  11. Web site: Stroustrup . Bjarne . Bjarne Stroustrup . 2007 . Bjarne Stroustrup's C++ Style and Technique FAQ . 15 February 2015.
  12. Web site: Spolsky . Joel . Joel Spolsky . 2005-05-11 . Making Wrong Code Look Wrong . Joel on Software . 2005-12-13 .
  13. Web site: Design Guidelines for Developing Class Libraries: General Naming Conventions . 2008-01-03.