венгерская нотация

Обозначение идентификатора компьютерного программирования

Венгерская нотация — это соглашение об именовании идентификаторов в компьютерном программировании , в котором имя переменной или функции указывает на ее намерение или вид, или в некоторых диалектах на ее тип . Первоначальная венгерская нотация использует только намерение или вид в своем соглашении об именовании и иногда называется Apps Hungary , поскольку она стала популярной в подразделении Microsoft Apps при разработке приложений Microsoft Office . Когда подразделение Microsoft Windows приняло соглашение об именовании, оно основывалось на фактическом типе данных, и это соглашение получило широкое распространение через Windows API ; иногда это называется системной венгерской нотацией.

Симони : ...BCPL [имел] единственный тип, который представлял собой 16-битное слово... не то чтобы это имело значение.

Буч : Если только вы не продолжите венгерскую нотацию.

Симони : Совершенно верно... позже мы перешли и к типизированным языкам... Но... мы бы посмотрели на одно имя, и я бы вам рассказал о нем очень много... ^[1]

Венгерская нотация была разработана как независимая от языка и нашла свое первое серьезное применение в языке программирования BCPL . Поскольку в BCPL нет других типов данных, кроме машинного слова , ничто в самом языке не помогает программисту запомнить типы переменных. Венгерская нотация направлена ​​на исправление этого, предоставляя программисту явное знание типа данных каждой переменной.

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

История

Оригинальная венгерская нотация была изобретена Чарльзом Симони , программистом, работавшим в Xerox PARC примерно в 1972–1981 годах, и позже ставшим главным архитектором в Microsoft . Название нотации является ссылкой на страну происхождения Симони, а также, по словам Энди Херцфельда , потому что она делала программы «выглядящими так, как будто они были написаны на каком-то непостижимом иностранном языке». ^[2] Имена венгерских людей «перевернуты» по сравнению с большинством других европейских имен; фамилия предшествует имени . Например, англизированное имя «Charles Simonyi» на венгерском языке изначально было «Simonyi Károly». Точно так же имя типа предшествует «имени» в венгерской нотации. Похожий стиль именования Smalltalk «type last» (например, aPoint и lastPoint) был распространен в Xerox PARC во время пребывания там Симони. ^{[ необходима цитата ]}

В статье Симони о нотации упоминаются префиксы, используемые для указания «типа» хранимой информации. ^{[3] [4]} Его предложение было в значительной степени связано с декорированием имен идентификаторов на основе семантической информации о том, что они хранят (другими словами, назначение переменной ). Нотация Симони стала называться Apps hung, поскольку это соглашение использовалось в отделе приложений Microsoft. Systems hung была разработана позже в команде разработчиков Microsoft Windows . Apps hung не полностью отличается от того, что стало известно как Systems hung, поскольку некоторые из предложенных Симони префиксов содержат мало или вообще не содержат семантической информации (см. примеры ниже). ^[4]

Системы венгерские против приложений венгерские

Различие в нотации Systems и нотации Apps заключается в назначении префиксов.

В нотации Systems Hungary префикс кодирует фактический тип данных переменной. Например:

• lAccountNum : переменная — длинное целое число ( "l");
• arru8NumberList : переменная представляет собой массив беззнаковых 8 - битных целых чисел ( ) "arru8";
• bReadLine(bPort,&arru8NumberList) : функция с кодом возврата байтового значения.
• strName : Переменная представляет собой строку ( "str"), содержащую имя, но не определяет, как эта строка реализована.

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

• rwPosition : переменная представляет строку ( "rw");
• usName : переменная представляет собой небезопасную строку ( "us"), которую необходимо «очистить» перед использованием (например, см. примеры атак, которые могут быть вызваны использованием необработанного пользовательского ввода, в разделах « Внедрение кода» и «Межсайтовый скриптинг» ).
• szName : переменная — это строка , заканчивающаяся нулем ( ) "sz"; это был один из первоначально предложенных Симони префиксов.

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

Ниже приведены примеры из оригинальной статьи: ^[3]

• pXявляется указателем на другой тип X ; он содержит очень мало семантической информации.
• d— это префикс, означающий разницу между двумя значениями; например, dY может представлять расстояние по оси Y графика, в то время как переменная, просто называемая y, может быть абсолютной позицией. Это полностью семантическое явление.
• szявляется строкой с нулевым или нулевым завершением. В языке C это содержит некоторую семантическую информацию, поскольку неясно, является ли переменная типа char* указателем на один символ, массив символов или строку с нулевым завершением.
• wобозначает переменную, которая является словом. Это по сути не содержит никакой семантической информации и, вероятно, будет считаться системным венгерским.
• bобозначает байт, который в отличие от w может иметь семантическую информацию, поскольку в C единственным типом данных размером в байт является char , поэтому они иногда используются для хранения числовых значений. Этот префикс может устранить неоднозначность между тем, содержит ли переменная значение, которое следует рассматривать как символ или число.

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

Код, использующий венгерскую нотацию Apps, иногда может содержать венгерскую нотацию Systems при описании переменных, которые определены исключительно в терминах их типа.

Отношение к сигилам

В некоторых языках программирования похожая нотация, которая теперь называется сигилы , встроена в язык и применяется компилятором. Например, в некоторых формах BASIC , name$именует строку и count%именует целое число . Основное различие между венгерской нотацией и сигилы заключается в том, что сигилы объявляют тип переменной в языке, тогда как венгерская нотация — это просто схема именования, не влияющая на машинную интерпретацию текста программы.

Примеры

• bBusy : Булево
• chInitial : символ
• cApples : количество элементов
• dwLightYears : двойное слово (Системы)
• fBusy : флаг (или плавающий )
• nSize : целое число (системы) или количество (приложения)
• iSize : целое число (системы) или индекс (приложения)
• fpPrice : с плавающей точкой
• decPrice : десятичный
• dbPi : двойной (Системы)
• pFoo : указатель
• rgStudents : массив или диапазон
• szLastName : строка с нулевым окончанием
• u16Identifier : беззнаковое 16-битное целое число (системы)
• u32Identifier : беззнаковое 32-битное целое число (системы)
• stTime : структура времени часов
• fnFunction : имя функции

Мнемоники для указателей и массивов , которые не являются фактическими типами данных, обычно сопровождаются типом самого элемента данных:

• pszOwner : указатель на строку, завершающуюся нулем
• rgfpBalances : массив значений с плавающей точкой
• aulColors : массив беззнаковых длинных чисел (системы)

Хотя венгерская нотация может применяться к любому языку программирования и среде, она была широко принята корпорацией Microsoft для использования с языком C, в частности, для Microsoft Windows , и ее использование в значительной степени ограничено этой областью. В частности, использование венгерской нотации было широко пропагандировано в книге Чарльза Петцольда " Программирование Windows" , оригинальной (и для многих читателей окончательной) книге по программированию Windows API . Таким образом, многие часто встречающиеся конструкции венгерской нотации специфичны для Windows:

• Для программистов, изучавших программирование для Windows на языке C, вероятно, наиболее памятными примерами являются wParam(параметр размера слова) и lParam(параметр длинного целого числа) для функции WindowProc ().
• hwndFoo : дескриптор окна
• lpszBar : длинный указатель на строку, заканчивающуюся нулем

В C++ эта нотация иногда расширяется, чтобы включить область действия переменной, опционально разделенную подчеркиванием. ^{[5] [6]} Это расширение часто также используется без венгерской спецификации типа:

• g_nWheels : член глобального пространства имен, целое число
• m_nWheels : член структуры/класса, целое число
• m_wheels, _wheels : член структуры/класса
• s_wheels : статический член класса
• c_wheels : статический член функции

В коде JavaScript, использующем jQuery , $префикс часто используется для указания того, что переменная содержит объект jQuery (а не простой объект DOM или какое-либо другое значение). ^[7]

Преимущества

(Некоторые из них применимы только к системам венгерского языка.)

Сторонники утверждают, что преимущества венгерской нотации включают в себя: ^[3]

• Тип символа можно увидеть из его имени. Это полезно при просмотре кода вне интегрированной среды разработки — например, при обзоре кода или распечатке — или когда объявление символа находится в другом файле с точки использования, например, в функции.
• В языке, который использует динамическую типизацию или который не типизирован, украшения, которые ссылаются на типы, перестают быть избыточными. В таких языках переменные обычно не объявляются как содержащие определенный тип данных, поэтому единственным ключом к тому, какие операции можно с ними выполнить, являются подсказки, данные программистом, такие как схема именования переменных, документация и комментарии. Как упоминалось выше, венгерская нотация расширилась в таком языке ( BCPL ).
• Форматирование имен переменных может упростить некоторые аспекты рефакторинга кода (но сделать другие аспекты более подверженными ошибкам).
• В блоке кода можно использовать несколько переменных со схожей семантикой: dwWidth, iWidth, fWidth, dWidth.
• Имена переменных можно легко запомнить, зная только их типы.
• Это приводит к более единообразным названиям переменных.
• Неправильное приведение типов и операции с использованием несовместимых типов можно легко обнаружить при чтении кода.
• В сложных программах со многими глобальными объектами (VB/Delphi Forms) наличие базовой префиксной нотации может облегчить работу по поиску компонента внутри редактора. Например, поиск строки btnможет найти все объекты Button.
• Применение венгерской нотации в более узком смысле, например, только для переменных-членов , помогает избежать конфликтов имен .
• Печатный код более понятен читателю в случае типов данных, преобразований типов, присваиваний, усечений и т. д.

Недостатки

Большинство аргументов против венгерской нотации направлены против нотации Systems hungary, а не Apps hungary ^{[ требуется ссылка ]} . Вот некоторые потенциальные проблемы:

• Венгерская нотация излишня, когда проверка типов выполняется компилятором. Компиляторы для языков, обеспечивающих строгую проверку типов, таких как Pascal , автоматически гарантируют, что использование переменной соответствует ее типу; проверки на глаз излишни и подвержены человеческим ошибкам.
• Большинство современных интегрированных сред разработки отображают типы переменных по требованию и автоматически отмечают операции, использующие несовместимые типы, что делает эту нотацию в значительной степени устаревшей.
• Венгерская нотация становится запутанной, когда она используется для представления нескольких свойств, например a_crszkvc30LastNameCol: константный ссылочный аргумент , содержащий содержимое столбца базы данныхLastName типа varchar (30), который является частью первичного ключа таблицы .
• Это может привести к несоответствию при изменении или переносе кода. Если тип переменной изменяется, то либо оформление имени переменной будет несовместимо с новым типом, либо имя переменной должно быть изменено. Особенно известным примером является стандартный тип WPARAM и сопутствующий формальный параметр wParam во многих объявлениях системных функций Windows. «W» означает «word», где «word» — это собственный размер слова аппаратной архитектуры платформы. Первоначально это был 16-битный тип на 16-битных архитектурах word, но был изменен на 32-битный на 32-битных архитектурах word или 64-битный тип на 64-битных архитектурах word в более поздних версиях операционной системы, при этом сохранив свое первоначальное имя (его истинный базовый тип — UINT_PTR, то есть беззнаковое целое число, достаточно большое, чтобы содержать указатель). Семантическое сопротивление и, следовательно, путаница и непоследовательность программистов от платформы к платформе, обусловлены предположением, что «w» обозначает двухбайтовое 16-битное слово в этих различных средах.
• В большинстве случаев знание использования переменной подразумевает знание ее типа. Более того, если использование переменной неизвестно, оно не может быть выведено из ее типа.
• Венгерская нотация снижает преимущества использования редакторов кода, поддерживающих автодополнение имен переменных, поскольку программисту сначала приходится вводить спецификатор типа, что с большей вероятностью приведет к конфликтам с другими переменными, чем при использовании других схем именования.
• Это делает код менее читабельным, поскольку скрывает назначение переменной с помощью префиксов типа и области действия. ^[8]
• Дополнительная информация о типе может недостаточно заменить более описательные имена. Например, sDatabase не сообщает читателю, что это такое. databaseName может быть более описательным именем.
• Когда имена достаточно описательные, дополнительная информация о типе может быть избыточной. Например, firstName, скорее всего, является строкой. Поэтому присвоение ему имени sFirstName только добавляет беспорядка в код.
• Труднее запомнить имена.
• В блоке кода можно использовать несколько переменных с различной семантикой с похожими именами: dwTmp, iTmp, fTmp, dTmp .
• Размещение идентификаторов типа данных или намерения символа в качестве префикса к имени поля или переменной подрывает возможность в некоторых средах программирования переходить к имени поля или переменной в алфавитном порядке, когда пользователь начинает вводить имя. Например, FileMaker ^[9] является одной из таких сред программирования. При использовании одной из этих сред программирования может быть предпочтительнее вместо этого добавлять к именам Данных такие идентифицирующие символы.

Известные мнения

• Роберт Сесил Мартин (против венгерской нотации и всех других форм кодирования):

  ... в настоящее время HN и другие формы кодирования типов являются просто помехами. Они затрудняют изменение имени или типа переменной, функции, члена или класса. Они затрудняют чтение кода. И они создают возможность того, что система кодирования введет читателя в заблуждение. ^[10]

• Линус Торвальдс (против «Системс Венгерс»):

  Кодирование типа функции в имени (так называемая венгерская нотация) — это ущербность для мозга, поскольку компилятор в любом случае знает типы и может их проверить, и это только запутывает программиста. ^[11]

• Стив Макконнелл (для Apps Hungary):

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

• Бьярне Страуструп (против систем венгерского языка за C++):

  Нет, я не рекомендую «венгерский». Я рассматриваю «венгерский» (встраивание сокращенной версии типа в имя переменной) как технику, которая может быть полезна в нетипизированных языках, но совершенно не подходит для языка, поддерживающего обобщенное программирование и объектно-ориентированное программирование — оба из которых подчеркивают выбор операций на основе типа и аргументов (известных языку или поддержке времени выполнения). В этом случае «встраивание типа объекта в имена» просто усложняет и минимизирует абстракцию. ^[13]

• Джоэл Спольски (для Apps Hungary):

  Если вы внимательно прочтете статью Симони, то увидите, что он имел в виду тот же тип соглашения об именовании, который я использовал в своем примере выше, где мы решили, что usозначает небезопасную строку, а sозначает безопасную строку. Они оба типа string. Компилятор не поможет вам, если вы назначите одно другому, и Intellisense [ интеллектуальная система завершения кода ] не сообщит вам о bupkis. Но они семантически различны. Их нужно интерпретировать по-разному и обрабатывать по-разному, и нужно будет вызвать какую-то функцию преобразования, если вы назначите одно другому, иначе у вас будет ошибка во время выполнения. Если вам повезет. Apps hung по-прежнему имеет огромную ценность, поскольку он увеличивает коллокацию в коде, что упрощает чтение, написание, отладку и поддержку кода, и, что самое важное, он заставляет неправильный код выглядеть неправильным.... (Systems hung) было тонким, но полным непониманием намерения и практики Симони. ^[4]

• Руководящие принципы проектирования Microsoft ^[14] не рекомендуют разработчикам использовать нотацию Systems hungary при выборе имен для элементов в библиотеках классов .NET, хотя она была распространена на предыдущих платформах разработки Microsoft, таких как Visual Basic 6 и более ранних. В этих руководящих принципах проектирования ничего не говорится о соглашениях об именовании локальных переменных внутри функций.

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

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

Ссылки

1. "Устная история Чарльза Симони" (PDF) . Archive.computerhistory.org\accessdate=5 августа 2018 г. Архивировано (PDF) из оригинала 2015-09-10.
2. Розенберг, Скотт (1 января 2007 г.). «Все, что вы можете сделать, я могу сделать мета». MIT Technology Review . Получено 21 июля 2022 г.
3. Чарльз Симони (ноябрь 1999). "Венгерская нотация". Библиотека MSDN . Microsoft Corp.
4. Spolsky, Joel (2005-05-11). "Заставить неправильный код выглядеть неправильным". Joel on Software . Получено 2005-12-13 .
5. "Mozilla Coding Style". Developer.mozilla.org . Архивировано из оригинала 2 декабря 2019 . Получено 17 марта 2015 .
6. "Руководство по стилю кодирования Webkit". Webkit.org . Получено 17 марта 2015 г. .
7. "Почему переменная JavaScript начинается со знака доллара?". Stack Overflow . Получено 12 февраля 2016 г.
8. Джонс, Дерек М. (2009). Новый стандарт C: Культурный и экономический комментарий (PDF) . Addison-Wesley. стр. 727. ISBN 978-0-201-70917-9. Архивировано (PDF) из оригинала 2011-05-01.
9. «Создайте приложение для любой задачи — FileMaker — дочерняя компания Apple». Filemaker.com . Получено 5 августа 2018 г. .
10. Мартин, Роберт Сесил (2008). Чистый код: Справочник по гибкому программному мастерству . Редмонд, Вашингтон: Prentice Hall PTR. ISBN 978-0-13-235088-4.
11. "Linux kernel coding style". Документация ядра Linux . Получено 9 марта 2018 г.
12. Макконнелл, Стив (2004). Code Complete (2-е изд.). Редмонд, Вашингтон: Microsoft Press . ISBN 0-7356-1967-0.
13. Страуструп, Бьярн (2007). «Часто задаваемые вопросы по стилю и технике C++ Бьярна Страуструпа» . Проверено 15 февраля 2015 г.
14. "Руководство по проектированию для разработки библиотек классов: общие соглашения об именовании" . Получено 2008-01-03 .

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

• Метапрограммирование: метод производства программного обеспечения Чарльз Симони, декабрь 1976 г. (кандидатская диссертация)
• Венгерская нотация — теперь моя очередь :) – Веблог Ларри Остермана
• Венгерская нотация (MSDN)
• HTML-версия статьи Дуга Кландера ^{[ постоянная мертвая ссылка ]}
• Соглашения об именовании RVBA
• Соглашения о стиле кодирования (MSDN)