비고
이 콘텐츠는 프레임워크 디자인 지침: 재사용 가능한 .NET 라이브러리에 대한 규칙, 관용구 및 패턴, 2판에서 Pearson Education, Inc.의 권한으로 다시 인쇄됩니다. 이 버전은 2008년에 출판되었으며, 이후 세 번째 에디션에서 완전히 수정되었습니다. 이 페이지의 일부 정보는 오래된 것일 수 있습니다.
이 섹션에서는 단어 선택과 관련된 일반적인 명명 규칙, 약어 및 약어 사용에 대한 지침 및 언어별 이름을 사용하지 않는 방법에 대한 권장 사항에 대해 설명합니다.
단어 선택
✔️ 쉽게 읽을 수 있는 식별자 이름을 선택합니다.
예를 들어, HorizontalAlignment로 이름이 지정된 속성은 AlignmentHorizontal보다 영어로 읽기에 더 용이합니다.
✔️ 간결성보다 가독성을 선호합니다.
속성 이름이 CanScrollHorizontally X축에 대한 모호한 참조보다 ScrollableX 낫습니다.
❌ 밑줄, 하이픈 또는 기타 무수 문자를 사용하지 마세요.
❌ 헝가리어 표기법을 사용하지 마세요.
❌ 널리 사용되는 프로그래밍 언어의 키워드와 충돌하는 식별자를 사용하지 마십시오.
CLS(공용 언어 사양) 규칙 4에 따르면 모든 규격 언어는 해당 언어의 키워드를 식별자로 사용하는 명명된 항목에 액세스할 수 있는 메커니즘을 제공해야 합니다. 예를 들어 C#은 이 경우 @ 기호를 이스케이프 메커니즘으로 사용합니다. 그러나 이스케이프 시퀀스가 없는 메서드보다 메서드를 사용하는 것이 훨씬 더 어렵기 때문에 일반적인 키워드를 피하는 것이 좋습니다.
약어 및 두문자어 사용
❌ 식별자 이름의 일부로 약어 또는 수축을 사용하지 마세요.
예를 들어, GetWindow 대신 GetWin를 사용하세요.
❌ 널리 받아들여지는 두문자어를 필요한 경우에만 사용하는 것이 좋습니다.
Language-Specific 이름 방지
✔️ 형식 이름에 언어별 키워드 대신 의미 체계적으로 흥미로운 이름을 사용하세요.
예를 들어, GetLength가 GetInt보다 더 나은 이름입니다.
✔️ 식별자에 해당 형식 이외의 의미 체계 의미가 없는 경우 드문 경우에서 언어별 이름이 아닌 일반 CLR 형식 이름을 사용합니다.
예를 들어, Int64로 변환하는 메서드의 이름은 ToInt64이 아니라 ToLong로 지정해야 합니다. 왜냐하면 Int64은 C#에 특정한 별칭long의 CLR 이름이기 때문입니다. 다음 표에서는 CLR 형식 이름(C#, Visual Basic 및 C++의 해당 형식 이름)을 사용하는 여러 기본 데이터 형식을 제공합니다.
| C# (프로그래밍 언어) | Visual Basic (비주얼 베이직 언어) | C++ | CLR (만약 기술 용어가 아니라면 '클리어'로 번역 가능합니다) |
|---|---|---|---|
| sbyte | SByte | 문자 | SByte |
| 바이트 | 바이트 | 서명되지 않은 문자 | 바이트 |
| 짧은 | 짧은 | 짧은 | int16 |
| ushort | UInt16 | 서명되지 않은 짧은 | UInt16 |
| int | 정수 | int | int32 |
| uint | UInt32 | 서명되지 않은 int | UInt32 |
| 길다 | 오래 | __int64 | Int64 |
| ulong | UInt64 | 서명되지 않은 __int64 | UInt64 |
| 플로트 | 싱글 | 플로트 | 싱글 |
| 더블 | 이중 | 더블 | 이중 |
| 부울 | Boolean | 부울 | Boolean |
| 문자 | Char(문자) | wchar_t | Char(문자) |
| 문자열 | 문자열 | 문자열 | 문자열 |
| 개체 | 객체 | 객체 | 객체 |
✔️ 식별자에 의미 체계 의미가 없고 매개 변수의 형식이 중요하지 않은 경우 드물게 형식 이름을 반복하는 대신 일반적인 이름(예: value 또는 item)을 사용합니다.
새 버전의 기존 API 이름 지정
✔️ 기존 API의 새 버전을 만들 때 이전 API와 유사한 이름을 사용합니다.
이렇게 하면 API 간의 관계를 강조 표시할 수 있습니다.
✔️ 접두사가 아닌 접미사를 추가하여 기존 API의 새 버전을 나타내는 것이 좋습니다.
이렇게 하면 설명서를 찾아보거나 IntelliSense를 사용할 때 검색에 도움이 됩니다. 대부분의 브라우저와 IntelliSense는 식별자를 사전순으로 표시하기 때문에 이전 버전의 API는 새 API에 가깝게 구성됩니다.
✔️ 접미사나 접두사를 추가하는 대신 새로운 의미 있는 식별자를 사용하는 것이 좋습니다.
✔️ 숫자 접미사를 사용하여 기존 API의 새 버전을 나타내며, 특히 API의 기존 이름이 적절한 유일한 이름(즉, 업계 표준인 경우)이고 의미 있는 접미사를 추가하거나 이름을 변경하는 것이 적절한 옵션이 아닌 경우를 지정합니다.
❌ 식별자에 "Ex"(또는 이와 유사한) 접미사를 사용하여 이전 버전의 동일한 API와 구분하지 마세요.
✔️ 32비트 정수 대신 64비트 정수(긴 정수)에서 작동하는 API 버전을 도입할 때는 "64" 접미사를 사용합니다. 기존 32비트 API가 있는 경우에만 이 방법을 사용해야 합니다. 64비트 버전만 있는 새로운 API에는 사용하지 마세요.
Microsoft Corporation의 일부 저작권 2005, 2009. 모든 권리 보유.
프레임워크 디자인 지침에서 Pearson Education, Inc.의 권한으로 재인쇄 : 재사용 가능한 .NET 라이브러리에 대한 규칙, 관용구 및 패턴, Krzysztof Cwalina 및 Brad Abrams의 제2판, Microsoft Windows 개발 시리즈의 일환으로 Addison-Wesley Professional이 2008년 10월 22일 출판했습니다.