헝가리안 표기법

3. 종류

헝가리안 표기법은 크게 시스템 헝가리안 표기법과 앱스 헝가리안 표기법으로 나뉜다. 이 두 표기법의 주요 차이점은 접두사의 목적에 있다.^[3]

시스템 헝가리안 표기법은 변수의 실제 데이터 형식을 나타내는 반면, 앱스 헝가리안 표기법은 변수의 논리적 데이터 형식이나 사용 목적을 나타낸다.

원래 헝가리안 표기법은 마이크로소프트의 응용 프로그램 개발 그룹에서 개발되어 엑셀이나 워드 등의 개발에 사용되었다. 이후 Windows 개발 그룹에서도 채택되었는데, 이때 시모니의 논문에서 "type"을 데이터 형식으로 오해하여 시스템 헝가리안 표기법이 널리 퍼지게 되었다.

3. 1. 시스템 헝가리안 표기법

• `lAccountNum`: 변수는 ''long integer'' ("l")이다.
• `arru8NumberList`: 변수는 ''"arr"'''ay of '''u'''nsigned '''8'''-bit integers'' ("arru8")이다.
• `bReadLine(bPort,&arru8NumberList)`: 바이트 값 반환 코드를 가진 함수이다.
• `strName`: 변수는 이름을 포함하는 문자열 ("str")을 나타내지만, 해당 문자열이 어떻게 구현되는지는 명시하지 않는다.

이 문자들은 조합하여 사용될 수 있다. 예를 들어 "lpsz: 널 종료 문자열에 대한 포인터", "m_ul: 멤버 변수의 부호 없는 롱 정수" 등과 같다.

널 종료를 나타내는 "z"는 대부분 널 종료 문자열을 나타내는 "sz"의 형태로 나타나지만, 드물게 센티넬로서 0 또는 Null을 배치하고 있는 가변 길이 배열이나 리스트 등의 자료 구조를 나타내기 위해 사용되는 예도 있다.

전역 변수나 멤버 변수를 나타내는 접두사는 변수의 자료형이 아닌 스코프를 구분하기 위한 것이므로, 시스템 헝가리안과 구분하는 시각도 있다.

3. 2. 앱스 헝가리안 표기법

• `rwPosition`: 변수는 ''row'' ("rw")를 나타낸다.
• `usName`: 변수는 사용하기 전에 "sanitize" 해야 하는 ''unsafe string'' ("us")을 나타낸다. (예: 원시 사용자 입력을 사용하여 발생할 수 있는 공격의 예는 코드 주입, 크로스 사이트 스크립팅 참조).
• `szName`: 변수는 '''''z'''ero-terminated '''s'''tring'' ("sz")이다. 이는 시모니가 제안한 원래 접두사 중 하나였다.

• `p''X''`는 다른 유형 ''X''에 대한 포인터이다. 이것은 거의 의미론적 정보를 포함하지 않는다.
• `''d''`는 두 값의 차이를 의미하는 접두사이다. 예를 들어, ''dY''는 그래프의 Y축을 따라가는 거리를 나타낼 수 있으며, ''y''라는 변수는 절대 위치일 수 있다. 이것은 본질적으로 의미론적이다.
• `''sz''`는 null 또는 zero로 종료되는 문자열이다. C에서 이 정보는 ''char*'' 유형의 변수가 단일 문자에 대한 포인터인지, 문자 배열인지, 또는 zero로 종료되는 문자열인지 명확하지 않기 때문에 약간의 의미론적 정보를 포함한다.
• `''w''`는 단어인 변수를 표시한다. 이것은 본질적으로 의미론적 정보를 전혀 포함하지 않으며, Systems 헝가리안으로 간주될 수 있다.
• `''b''`는 바이트를 표시하며, w와 대조적으로 의미론적 정보를 가질 수 있다. 왜냐하면 C에서 바이트 크기의 유일한 데이터 유형은 ''char''이기 때문에, 이것은 때때로 숫자 값을 저장하는 데 사용되기 때문이다. 이 접두사는 변수가 문자로 취급되어야 하는 값인지, 숫자로 취급되어야 하는 값인지에 대한 모호성을 해소할 수 있다.

4. 시길(Sigils)과의 관계

일부 프로그래밍 언어에서는 시길이라고 불리는 유사한 표기법이 언어에 내장되어 컴파일러에 의해 강제된다. 예를 들어, 일부 형태의 BASIC에서는 `name$`가 문자열을, `count%`가 정수를 명명한다. 헝가리안 표기법과 시길의 주요 차이점은 시길은 언어에서 변수의 유형을 선언하는 반면, 헝가리안 표기법은 프로그램 텍스트의 기계적 해석에 영향을 미치지 않는 순수한 명명 방식이라는 것이다.

5. 예시

Hungarian notation^영어은 변수나 함수의 이름에 그 종류나 의도에 대한 정보를 포함하는 명명 규칙이다.

다음은 원본 논문에 있는 예시이다:^[3]

• `pX`: 다른 유형 `X`에 대한 포인터. 의미 정보가 거의 없다.
• `d`: 두 값의 차이를 의미하는 접두사. 예를 들어 `dY`는 그래프의 Y축 거리를 나타낼 수 있으며, `y` 변수는 절대 위치일 수 있다. 의미론적이다.
• `sz`: null 또는 0으로 끝나는 문자열. C에서 `char*` 유형의 변수가 단일 문자에 대한 포인터인지, 문자 배열인지, 0으로 끝나는 문자열인지 명확하지 않기 때문에 약간의 의미론적 정보를 포함한다.
• `w`: 워드인 변수를 표시한다. 의미론적 정보를 거의 포함하지 않으며, Systems 헝가리안으로 간주될 수 있다.
• `b`: 바이트를 표시하며, w와 대조적으로 의미론적 정보를 가질 수 있다. C에서 바이트 크기의 유일한 데이터 유형은 `char`인데, 숫자 값을 저장하는 데 사용되기도 하기 때문이다. 이 접두사는 변수가 문자로 취급되어야 하는 값인지, 숫자로 취급되어야 하는 값인지에 대한 모호성을 해소한다.

실제 데이터 형식이 아닌 포인터와 배열에 대한 니모닉은 일반적으로 데이터 요소 자체의 유형이 뒤따른다.

• `pszOwner`: 널 종료 문자열에 대한 포인터
• `rgfpBalances`: 부동 소수점 값의 배열
• `aulColors`: 부호 없는 long의 배열 (시스템)

• C로 윈도우 프로그래밍을 배운 프로그래머에게 가장 기억에 남는 예는 WindowProc() 함수의 `wParam` (워드 크기 매개변수) 및 `lParam` (long-integer 매개변수)일 것이다.
• `hwndFoo`: 윈도우 핸들
• `lpszBar`: 널 종료 문자열에 대한 long 포인터

• `g_nWheels`: 전역 네임스페이스의 멤버, 정수
• `m_nWheels`: 구조체/클래스의 멤버, 정수
• `m_wheels`, `_wheels`: 구조체/클래스의 멤버
• `s_wheels`: 클래스의 정적 멤버
• `c_wheels`: 함수의 정적 멤버

이것들은 조합하여 사용될 수도 있다. 예를 들어 "lpsz: 널 종료 문자열에 대한 포인터", "m_ul: 멤버 변수의 부호 없는 롱 정수" 등과 같은 형식이다.

널 종료를 나타내는 "z"는, 대부분의 경우 널 종료 문자열을 나타내는 "sz"의 형태로 나타나지만, 드물게 센티넬로서 0 또는 Null을 배치하고 있는 가변 길이 배열이나 리스트 등의 자료 구조를 나타내기 위해 사용되는 예도 있다.

전역 변수나 멤버 변수를 나타내는 접두사는, 변수의 자료형이 아닌 범위를 구분하기 위한 것이므로, 시스템 헝가리안과 구분하는 시각도 있다.

6. 장점

헝가리안 표기법의 지지자들은 다음과 같은 장점을 제시한다.^[3]

• 변수의 자료형을 이름에서 바로 알 수 있다. 이는 통합 개발 환경 외부(코드 검토나 인쇄물 등)에서 코드를 보거나, 변수 선언이 사용 지점과 다른 파일(예: 함수)에 있을 때 유용하다.
• 동적 타이핑을 사용하거나 타입이 없는 언어에서 자료형을 나타내는 접두어는 더 이상 불필요하지 않다. 이러한 언어에서는 변수가 특정 유형의 데이터를 담도록 선언되지 않으므로, 프로그래머가 변수명 규칙, 문서 및 주석을 통해 제공하는 힌트가 변수에 대해 수행할 수 있는 연산에 대한 유일한 단서가 된다. 헝가리안 표기법은 이러한 언어(BCPL)에서 확장되었다.
• 변수명 형식을 사용하면 코드 리팩토링의 일부 측면이 단순화될 수 있다(다른 측면은 오류가 발생하기 쉬워짐).
• 코드 블록에서 유사한 의미를 가진 여러 변수를 사용할 수 있다. (예: dwWidth, iWidth, fWidth, dWidth)
• 변수 유형만 알아도 변수 이름을 쉽게 기억할 수 있다.
• 변수 이름이 더 일관성을 갖게 된다.
• 부적절한 유형 캐스팅 및 호환되지 않는 유형을 사용한 연산을 코드를 읽는 동안 쉽게 감지할 수 있다.
• 많은 전역 객체(VB/Delphi Forms)가 있는 복잡한 프로그램에서 기본 접두사 표기법을 사용하면 편집기 내에서 구성 요소를 찾는 작업이 쉬워진다. 예를 들어, `btn` 문자열을 검색하면 모든 Button 개체를 찾을 수 있다.
• 헝가리안 표기법을 멤버 변수에만 적용하는 좁은 방식으로 사용하면 이름 충돌을 피하는 데 도움이 된다.
• 데이터 유형, 유형 변환, 할당, 잘라내기 등의 경우 인쇄된 코드가 읽는 사람에게 더 명확하게 보인다.

7. 단점

헝가리안 표기법에 대한 대부분의 반대 의견은 "시스템" 헝가리안 표기법에 대한 것이지 "앱" 헝가리안 표기법에 대한 것은 아니다.^[7] 잠재적인 문제점은 다음과 같다.

• 컴파일러가 형식 검사를 수행할 때 중복된다. 파스칼과 같이 엄격한 형식 검사를 제공하는 언어의 컴파일러는 변수의 사용이 해당 형식과 일치하는지 자동으로 확인한다. 눈으로 확인하는 것은 중복되며 인적 오류가 발생하기 쉽다.
• 대부분의 최신 통합 개발 환경은 필요에 따라 변수 형식을 표시하고 호환되지 않는 형식을 사용하는 연산을 자동으로 플래그 표시하므로 이 표기법은 거의 쓸모가 없어졌다.
• 여러 속성을 나타내는 데 사용될 때 혼란스러워진다.
• 코드가 수정되거나 이식될 때 일관성이 없어질 수 있다. 변수의 형식이 변경되면 변수 이름의 장식이 새 형식과 일치하지 않거나 변수 이름을 변경해야 한다.
• 대부분의 경우 변수의 사용법을 알면 해당 형식을 아는 것이 된다. 또한, 변수의 사용법을 모르는 경우 해당 형식에서 유추할 수 없다.
• 프로그래머가 형식 지정자를 먼저 입력해야 하므로 변수 이름에 대한 자동 완성을 지원하는 코드 편집기를 사용할 때의 이점을 감소시킨다.
• 형식 및 범위 접두사로 변수의 목적을 모호하게 하여 코드를 덜 읽기 쉽게 만든다.^[7]
• 추가적인 형식 정보는 더 설명적인 이름을 충분히 대체하지 못할 수 있다.
• 이름이 충분히 설명적인 경우 추가적인 형식 정보가 중복될 수 있다. 예를 들어 firstName은 문자열일 가능성이 높다. 따라서 sFirstName으로 이름을 지정하면 코드에 불필요한 내용만 추가된다.
• 이름을 기억하기가 더 어렵다.
• 여러 변수는 코드 블록에서 유사한 이름으로 사용될 수 있지만, '''다른''' 의미를 갖는다.

8. 비판

로버트 C. 마틴은 헝가리안 표기법 및 기타 모든 형태의 인코딩은 변수, 함수, 멤버 또는 클래스의 이름이나 유형을 변경하기 어렵게 만들고, 코드를 읽기 어렵게 만들며, 독자를 오도할 가능성을 만든다고 비판한다.^[8] 리누스 토르발스는 함수의 유형을 이름에 인코딩하는 것은 컴파일러가 어차피 타입을 확인하는데 프로그래머를 혼란스럽게 할 뿐이라고 지적한다.^[9]

비야네 스트롭스트루프는 '헝가리안' 표기법이 유형이 없는 언어에서는 유용할 수 있지만, 제네릭 프로그래밍과 객체 지향 프로그래밍을 지원하는 언어에는 부적합하다고 말한다. 객체의 유형을 이름에 포함시키면 추상화가 복잡해지고 최소화된다는 것이다.^[11]

C++(C++)나 C#과 같은 언어에서는 형 지정이 존재하기 때문에 시스템 헝가리안 표기법을 사용하는 것에 대한 이점은 없다.^[19][20] 과거 윈도우 API/MFC에서 헝가리안 표기법을 전면적으로 채택했던 마이크로소프트 스스로가 .NET Framework에서는 헝가리안 표기법을 금지하고 있다.^[16]

마이크로소프트의 응용 프로그램 개발 그룹에서 개발된 이 표기법은 엑셀이나 워드 등의 개발에서 성공을 거두었기 때문에, Windows 개발 그룹에서도 채용되었다. 그때, 시모니의 논문 중 "type"이 데이터 형식을 의미하는 것으로 오해되어, 변수명에 데이터 형식을 나타내는 접두어 또는 접미어를 붙이는 표기법이라고 오해되었다. 시모니가 의도했던 표기법을 어플리케이션 헝가리안, 오해에 기반한 표기법을 시스템 헝가리안이라고 부른다. Windows API 및 MFC는 대부분 시스템 헝가리안을 따른다. 시스템 헝가리안은 비판받는 경우가 많고, .NET Framework에서는 사용되지 않는다.^[16] COM도 시스템 헝가리안이 전통적으로 사용되었지만, .NET의 등장 이후 새롭게 추가된 컴포넌트에 관해서는 시스템 헝가리안을 채용하지 않는 경우가 늘고 있다.^[17]

헝가리안 표기법에 두 종류가 있다는 것은 잘 알려져 있지 않으며, 단순히 "헝가리안 표기법"이라고 언급될 경우에도, 시스템 헝가리안의 의미로 사용되는 경우가 많다. 시스템 헝가리안은 모든 접두사를 사용하며, C 언어 및 C++ 특유의 언어 사양, 언어 기능 및 자료형에 의존하는 규칙이 대부분이다.

위 표의 접두사들은 조합하여 사용될 수도 있다. 예를 들어 "lpsz: 널 종료 문자열에 대한 포인터", "m_ul: 멤버 변수의 부호 없는 롱 정수" 등과 같은 형식이다. 널 종료를 나타내는 "z"는 대부분의 경우 널 종료 문자열을 나타내는 "sz"의 형태로 나타나지만, 드물게 센티넬로서 0 또는 Null을 배치하고 있는 가변 길이 배열이나 리스트 등의 자료 구조를 나타내기 위해 사용되는 예도 있다.

전역 변수나 멤버 변수를 나타내는 접두사는 변수의 자료형이 아닌 스코프를 구분하기 위한 것이므로, 시스템 헝가리안과 구분하는 시각도 있다.

참조

_[1] 웹사이트 Oral History of Charles Simonyi http://archive.compu[...] 2018-08-05
_[2] 뉴스 Anything You Can Do, I Can Do Meta https://www.technolo[...] 2022-07-21
_[3] 웹사이트 Hungarian Notation http://msdn2.microso[...] Microsoft Corp. 1999-11
_[4] 웹사이트 Mozilla Coding Style https://web.archive.[...] 2015-03-17
_[5] 웹사이트 Webkit Coding Style Guidelines http://www.webkit.or[...] 2015-03-17
_[6] 웹사이트 Why would a JavaScript variable start with a dollar sign? https://stackoverflo[...] 2016-02-12
_[7] 서적 The New C Standard: A Cultural and Economic Commentary http://www.coding-gu[...] Addison-Wesley
_[8] 서적 Clean Code: A Handbook of Agile Software Craftsmanship Prentice Hall PTR 2008
_[9] 웹사이트 Linux kernel coding style https://www.kernel.o[...] 2018-03-09
_[10] 서적 Code Complete Microsoft Press 2004
_[11] 웹사이트 Bjarne Stroustrup's C++ Style and Technique FAQ http://www.stroustru[...] 2015-02-15
_[12] 웹사이트 Making Wrong Code Look Wrong http://www.joelonsof[...] 2005-12-13
_[13] 웹사이트 Design Guidelines for Developing Class Libraries: General Naming Conventions http://msdn2.microso[...] 2008-01-03
_[14] 웹사이트 間違ったコードは間違って見えるようにする http://local.joelons[...] 2005-05-11
_[15] 웹사이트 Hungarian Notation https://docs.microso[...] 2019-10-05
_[16] 웹사이트 一般的な名前付け規則 https://docs.microso[...] 2019-10-05
_[17] 웹사이트 Windows Ribbon Framework | Microsoft Docs https://docs.microso[...]
_[18] 서적 C++ Coding Standards: 101 Rules, Guidelines, and Best Practices (C++ In-Depth Series) Addison-Wesley Professional 2004-10-25
_[19] 웹사이트 Stroustrup: C++ Style and Technique FAQ http://www.stroustru[...] 2019-10-05
_[20] 웹사이트 Stroustrup: C++ Glossary http://www.stroustru[...] 2017-10-22