헝가리안 표기법

1. 개요

2. 적용하기

2.1. Systems Notation

2.1.1. 공통

2.1.2. OOP

2.1.3. Windows API

2.2. Apps Notation

2.2.1. 예시

#!syntax java
int sValue = usValue; // Unsafe 값을 Safe 변수에 바로 넣었다. 양변의 의미가 다르므로 문제가 있는 코드

sValue = sCheck(usValue); // us값을 체크해서 s로 바꿔주는 함수 sCheck를 거쳤다. 양변이 모두 s이므로 문제없는 코드

sValue = sCheckLocked(usValue); // 의미는 맞지만 Locked 함수를 쓰기 전에 락을 걸지 않았다. 멀티스레드에서 동작시 문제가 생길 수 있다.

3. 장점

• 데이터 타입을 변수명에서 바로 추정할 수 있다.
• IDE가 없을 때 작업하는 경우 (특히 vi나 emacs로 터미널에서 작업할 때) 여러모로 유리해진다.
• 같은 의미를 가지는 서로 다른 타입의 변수가 있을 때 이름 충돌을 방지할 수 있다.

4. 단점

• 변수나 함수 인자의 이름을 기억하기가 힘들다.
• 데이터 타입이 바뀌면 변수 또는 함수 인자의 이름을 바꿔야 한다. 리팩토링을 지원하는 IDE가 없으면 지옥도가 펼쳐질 것이다.
• 코드의 의미론을 해친다. 나이를 굳이 iAge로 표기해야 할까? 나이는 따로 표기하지 않아도 정수형인 게 자연스럽다.
• 코드의 가독성을 해친다. 사람은 문자를 읽을 때 마음속으로 모든 글자를 소리내어 발음하게 된다. m_iAge 는 "엠, 아이 에이지"로 읽지만 Age 는 그냥 "에이지"로 읽게 된다. 불필요한 문자들의 추가는 가독성을 현저히 떨어뜨리며 코드를 이해하는 데 방해가 된다.
• 시스템 아키텍처에 따라 데이터 타입의 명세가 암묵적으로 바뀌는 경우 혼란을 빚게 된다.[5] 예를 들어 w는 16비트일까? 32비트일까? 64비트일까?
• primitive type 강박증이 생긴다. 객체지향적이고 제네릭한 코드를 짜기 힘들어진다. 헌데 이건 헝가리안이 OOP가 없던 시절에 나온 표기법이라 당연한 것이다. 표기법 자체가 아니라, 환경이 달라졌는데도 계속 쓰는 사람이 문제다.

5. 몰락과 유산

• 클래스 멤버의 접근 수준을 명시하기 위해 심볼 앞에 밑줄(_) 붙이기.
  개발 언어가 접근 제한자를 지원하지 않을 때 자주 쓰인다. Python은 아예 _(밑줄 1개)를 protected로, __(밑줄 2개)를 private으로 간주하는 것이 표준 명세다.
• 내부 명세와 외부 명세를 가려야 할 때 심볼 앞에 _ 또는 m 붙이기.
  컬렉션 등 필드 내에서 다른 참조를 가리켜 mutable(읽고 쓰기가 가능)와 immutable(읽기만 가능)을 구분지어야 하는 경우나, 내부 자료형과 외부 자료형이 일치하지 않는 등으로 외부 접근 시 전처리를 거쳐야 하는 경우 많이 쓰인다. 가령 같은 참조를 mList와 list로 구분하여, 내부에서만 사용하는 mList는 mutable로 사용하고, 외부에 노출되는 list는 immutable로 사용하는 식. Android의 내부 코드가 이렇게 구현되어 있다. Kotlin, C# 등 속성 기능을 지원하는 프로그래밍 언어에서 이런 특징이 더 두드러지는데, 내부 사용과 외부 노출을 확실히 구분지어야 하는 일이 자주 일어나기 때문이다.[6]
• 쓰지 않는 변수의 심볼을 다른 문자 없이 _만 여러 개 이어붙여서 만들기.
  아예 _를 예약어로 정의해, 굳이 구분짓지 않고 통일시켜도 문제가 되지 않는 경우도 있다. Kotlin이나 JavaScript 등이 이런 예. Java의 경우 1.7까지는 식별자 이름으로 쓸 수 있었으나, 1.8에서 사용 자제가 권고되더니, 9에서는 아예 예약어로 변경돼 식별자 이름으로 사용할 수 없게 되었다.
• 참거짓 자료형 심볼 앞에 is 붙이기.
  정 붙일 이름이 없을 때 궁여지책으로 쓰게 된다. 다른 자료형과 달리 참거짓형은 변수 이름을 붙이기 애매할 때가 많기 때문이다. 그래도 가능한 한 의미론적인 명명 규칙을 적용하는 게 좋다. (예: isCompleted 대신 completed)
• 심볼 뒤에 enum, type 등 붙이기.

6. 관련 문서

• https://en.wikipedia.org/wiki/Hungarian_notation
• https://msdn.microsoft.com/en-us/library/aa260976(VS.60).aspx - 찰스 시모니가 MS에서 제안한 표기법 문서 (MSDN)
• https://msdn.microsoft.com/en-us/library/aa378932(VS.85).aspx - MS 코딩 규칙