일반 명명 규칙
참고 항목
이 콘텐츠는 Pearson Education, Inc.의 허가를 받아 프레임워크 디자인 지침: 재사용 가능한 .NET 라이브러리에 대한 규칙, 관용어 및 패턴, 2판에서 재인쇄되었습니다. 이 버전은 2008년에 출판되었으며 이후 3판에서 완전히 개정되었습니다. 이 페이지의 정보 중 일부는 최신 정보가 아닐 수 있습니다.
이 섹션에서는 단어 선택 관련 일반 명명 규칙, 약어 및 머리글자어 사용 관련 지침 및 특정 언어에 국한되는 이름을 사용하지 않는 방법을 설명합니다.
단어 선택
✔️ 쉽게 읽을 수 있는 식별자 이름을 선택하세요.
예를 들어 HorizontalAlignment라는 이름의 속성은 AlignmentHorizontal보다 영어로 읽기가 쉽습니다.
✔️ 간결함보다는 가독성을 우선하세요.
속성 이름 CanScrollHorizontally는 (X축에 대한 모호한 참조인) ScrollableX보다 더 좋은 이름입니다.
❌ 밑줄이나 하이픈 같은 영숫자가 아닌 문자를 사용하지 마세요.
❌ 헝가리식 표기법을 사용하지 마세요.
❌ 널리 사용되는 프로그래밍 언어의 키워드와 충돌하는 식별자를 사용하지 마세요.
CLS(공용 언어 사양)의 규칙 4에 따라 모든 규격 언어는 해당 언어의 키워드를 식별자로 사용하는 명명된 항목에 대한 액세스를 허용하는 메커니즘을 제공해야 합니다. 예를 들어 C#에서는 이 경우 @ 기호를 이스케이프 메커니즘으로 사용합니다. 하지만 이스케이프 시퀀스가 있는 메서드는 그렇지 않은 메서드보다 사용하기가 훨씬 어렵기 때문에 공용 키워드는 사용하지 않는 것이 좋습니다.
약어 및 머리글자어 사용
❌ 약어나 축약어를 식별자 이름의 일부로 사용하지 마세요.
예를 들어 GetWin 대신 GetWindow를 사용하세요.
❌ 일반적으로 받아들여지지 않는 머리글자어는 사용하지 말고, 받아들여지는 머리글자어라도 필요할 때만 사용하세요.
특정 언어에 국한되는 이름 사용 금지
✔️ 형식 이름에는 특정 언어에 국한되는 키워드 대신 흥미로운 의미를 담은 이름을 사용하세요.
예를 들어 GetInt보다는 GetLength가 더 좋은 이름입니다.
✔️ 드물지만 식별자에 형식 이상의 의미가 없다면 특정 언어에 국한되는 이름 대신 일반적인 CLR 형식 이름을 사용하세요.
예를 들어 Int64로 변환하는 메서드는 이름은 ToLong이 아닌 ToInt64로 지정해야 합니다(Int64는 C# 전용 별칭인 long의 CLR 이름이기 때문입니다). 다음 표에는 CLR 형식 이름(및 해당하는 C#, Visual Basic, C++용 형식 이름)을 사용하는 다양한 기본 데이터 형식이 나와 있습니다.
| C# | Visual Basic | C++ | CLR |
|---|---|---|---|
| sbyte | SByte | char | SByte |
| 바이트 | Byte | unsigned char | Byte |
| short | Short | short | Int16 |
| ushort | UInt16 | unsigned short | UInt16 |
| int | 정수 | int | Int32 |
| uint | UInt32 | unsigned int | UInt32 |
| long | Long | __int64 | Int64 |
| ulong | UInt64 | unsigned __int64 | UInt64 |
| float | Single | float | Single |
| double | double | double | double |
| 부울 | 부울 | 부울 | 부울 |
| char | Char | wchar_t | Char |
| string | String | String | String |
| object | Object | Object | Object |
✔️ 드물지만 식별자에 특별한 의미가 없으며 매개 변수의 형식이 중요하지 않다면 형식 이름을 반복해서 사용하지 말고 value나 item 같은 일반적인 이름을 사용하세요.
기존 API 새 버전의 이름 지정
✔️ 기존 API의 새 버전을 만들 때는 기존 API와 유사한 이름을 사용하세요.
이렇게 하면 API 간의 관계를 쉽게 강조할 수 있습니다.
✔️ 접두사 대신 접미사를 추가하여 기존 API의 새 버전을 표시하세요.
이렇게 하면 설명서를 살펴보거나 IntelliSense를 사용할 때 쉽게 찾을 수 있습니다. 대부분의 브라우저와 IntelliSense에서는 식별자를 알파벳순으로 표시하므로 이전 버전 API는 새 API와 거의 유사하게 구성됩니다.
✔️ 접미사나 접두사를 추가하는 대신 의미 있는 새 식별자를 사용해 보세요.
✔️ 숫자 접미사를 사용해 기존 API의 새 버전을 표시하세요. API의 기존 이름이 의미가 통하는 유일한 이름이며(즉 업계 표준이며) 의미 있는 접미사 추가가 (또는 이름 변경이) 적절한 선택지가 아닐 때는 이 방법이 특히 유용합니다.
❌ 동일한 API의 이전 버전과 구분하기 위해 식별자에 ‘Ex’(또는 이와 유사한) 접미사를 사용하지 마세요.
✔️ 32비트 정수 대신 64비트 정수(long 정수)에서 작동하는 API 버전을 도입할 때는 ‘64’ 접미사를 사용하세요. 이 방법은 기존 32비트 API가 있을 때만 사용해야 합니다. 64비트 버전만 있는 새 API에는 사용하지 마세요.
Portions © 2005, 2009 Microsoft Corporation. All rights reserved.
Pearson Education, Inc의 동의로 재인쇄. 출처: Framework Design Guidelines: Conventions, Idioms, and Patterns for Reusable .NET Libraries, 2nd Edition 작성자: Krzysztof Cwalina 및 Brad Abrams, 출판 정보: Oct 22, 2008 by Addison-Wesley Professional as part of the Microsoft Windows Development Series.