.NET Naming Rule 2009.10.07

1. .NET Naming Rule 2009.10.07

2. .NET Naming Rule Guide Line 명명 규칙 • 개발 업무 시, 각 개발 요소에 대한 이름으로 명명 규칙을 준수함으로써 코드의 안정성과 가독성을 향상시키고명확한 의미 부여 및 생산성을 높일 수 있습니다. 명명 규칙 준수를 통한 업무 생산성 효과 - 일종의 규약을 설정하여 프로젝트 개발자 간의 원활한 업무적 의사 소통 가능 - 업무 단계별 산출물 사이의 일관성 유지 - 명확한 의미 부여로 산출물 사이의 연관성 및 코드 가독성 향상 명명 규칙 준수 시 공통 사항 - 임의(정의되지 않은)의 약어 대신 완벽한 단어를 사용한다. (약어 사용시, 정의된 약어 사용) - 명칭의 가독성을 높이기 위해 대소문자를 원칙에 따라 혼용하여 사용한다. - 업무 영역에 적합하고 연관된 용어를 선정 및 정의한다. - 같은 유형의 요소에 대해서는 혼동을 방지하기 위해 유사 명칭이나, 대소문자만 다른 명칭은 사용 금지한다. - 너무 긴 명칭을 삼가한다.(15자 이내 권장) - .NET Framework 및 각 언어에서 미리 정의된 키워드 이름과 중복되지 않아야 한다.

3. .NET Naming Rule Guide Line 명명 규칙 표기법

4. .NET Naming Rule Guide Line 클래스(Class) 클래스 명은 간단하면서도 설명이 되도록 명명한다. 단수 명사(명사, 명사구)를 사용하는 것을 원칙으로 하며, 여러 개의 단어가 결합해야 할 경우는 명사 + 동사(MemberList)의 형태로 사용한다. 정해진 약어를 제외하고는 완전한 단어를 사용하며, 표기법은 Pascal Case을 적용한다.

5. .NET Naming Rule Guide Line 베이스 클래스(Base Class) 공통적으로 사용하는 부모 클래스를 의미하며, 어플리케이션 아키텍처에 의해 정의해 각 Role별로 그 공통된 기능을 미리 정의한 클래스이다. 각각의 Role에 해당하는 Class를 생성하여 사용하는 경우에는 반드시 해당하는 Base Class로부터 상속 받아서 사용하도록 한다. 베이스 클래스는 각 Layer별로 필요한 Utility API를 포함하거나, 권한인증 및 Logging 등의 특별한 공통기능을 수행한다.

6. .NET Naming Rule Guide Line 인터페이스(Interface) • 클래스 명명 규칙과 동일하며, 대문자 I를 접두사로 사용하여 인터페이스인지 구분할 수 있도록 한다. • ex) IServiceProvider, Icomponent 메서드 동사 / 동사구(동사 + 명사)를사용하며 표기법은 Pascal Case를 적용하고, 파라미터는 일반적으로 Camel 표기법을 사용하며 이름과 타입으로 의미를 확인할 수 있을 정도로 설명적이여야 한다. ex) GetUsers(), RegisterUser(string userId) Business Rule, Data Access 계층의 클래스 메서드는 사전에 약속된 동사를 사용한다.

7. .NET Naming Rule Guide Line 변수(Variant) 및 필드(Field) 변수 이름은 짧으면서도 의미가 있는 단어를 사용한다. 기본적으로 Camel Case를 사용한다. ex) empName, result, name 데이터 관련 변수(오른쪽 표 참고)와 UI 컨트롤의경우(부록 참고)는 타입을 나타내는 접두어를 붙여 표기한다. (Hungarian Case 표기법) ex) dtResult, drSelectedRow, ibtnSearch(Image Button), btnSelect 매개 변수, 지역 변수, 인스턴스 필드는 Camel Case를 사용하고, 정적 필드는 Pascal Case를 적용한다. 멤버 변수도 일반 변수와 마찬가지로 Camel Case 표기법을 사용하나, 일반 메소드 내부 변수와 구분을 하기 위해 this 를 사용한다. ex) private string memberName; public void SomeMethod(string memberName){ this.memberName = memberName } 데이터 관련 변수 접두어

8. .NET Naming Rule Guide Line 상수(Constants) 1. 표기법은 Upper Case를 사용하며, 단어와 단어 사이는 _로 연결한다. ex) int MAX_COUNT = 1000; 속성(Property) Pascal Case 표기법을 사용한다. 내부 type(private)과 동일한 이름을 사용한다. Private 인스턴스 필드를 외부에 노출 시, Pascal Case 표기법을 사용한다. ex) // 내부 type인 경우, Camel Case 적용 private intitemCount; // Private 인스턴스 필드를 외부에 노출하고자 하는 경우, Pascal Case 적용 public intItemCount { get { … } set { … } }

9. .NET Naming Rule Guide Line 이벤트(Event) 표기법은 Pascal Case를 적용하며, 이벤트 처리ㄹ기 이름에는 EventHandler접미사를 사용한다. ex) MouseEventHandler 이벤트 인수 클래스 이름에는 EventArgs접미사를 사용한다. ex) MouseEventArgs public delegate void MouseEventHandler(object sender, MouseEventArgs e); 시점을 나타내는 경우,BeforeXXX / AfterXXX대신 ~ing / ~(e)d 형태를 사용한다. ex) BeforeClose, AfterClose Closing, Closed

10. .NET Naming Rule Guide Line 네임스페이스(Namespace) Pascal Case 를 적용한다. (기본 구조) 회사명.도메인/부서.애플리케이션/시스템명.하위시스템.논리적계층 ex) Microsoft.Windows.WindowsServer.IIS 업무 시스템에 맞게 ‘도메인/부서’, ‘하위 시스템’, ‘논리적 계층’ 등은 생략 가능하다. ex) NEO.Development.MessengerApp

11. .NET Naming Rule Guide Line 네임스페이스(Namespace) Server Component Layer는 서브 시스템 아래 Layer 별로 네임스페이스 명을 지정한다. ex) NEO.Development.MessengerApp.Web

12. .NET Naming Rule Guide Line 부록 1. 웹폼 컨트롤에 따른 접두어(1)

13. .NET Naming Rule Guide Line 부록 1. 웹폼 컨트롤에 따른 접두어(2)

14. .NET Naming Rule Guide Line 부록 2. HTML 컨트롤에 따른 접두어

15. .NET Naming Rule Guide Line 부록 3. 윈폼 컨트롤에 따른 접두어(1)

16. .NET Naming Rule Guide Line 부록 3. 윈폼 컨트롤에 따른 접두어(2)

17. .NET Naming Rule Guide Line 부록 4. 샘플 예제 소스 (1)

18. .NET Naming Rule Guide Line 부록 4. 샘플 예제 소스 (2)