Dot net Framework Design Guidelines

 Coding하실 때 Guideline을 따라서 Coding하고 계신가요? 아니면 저 처럼 Googling에서 나오는 예제를 보고 coding하고 계시진 않나요? 저는 오늘 C# code refactoring을 하던 중 coding guideline에 따라 제대로 하고 싶다는 생각에 C# coding guideline을 찾아 봤습니다.  

 

 제가 찾은 자료는 Microsoft에서 제공하는 Framework Design Guidelines입니다. 저도 c# coding을 하고 있지만, 이런 coding guideline문서를 정독해 본적이 없다는 사실을 부끄러워 하게 만드는 자료입니다. 이제부터라도 정독하고 열심히 guideline을 준수하면서 coding해야 겠습니다. 오늘은 Overview에 대해 간략히 보고, detail한 내용 새로운 posting을 통해 알아 보겠습니다.

 Microsoft에서도 언급되어 있듯이 website에서 제공하는 내용들은 2008년 출간된 아래 책에서 나온 것입니다. 현재는 절판되었네요.
Design Guidelines: Conventions, Idioms, and Patterns for Reusable .NET Libraries, 2nd Edition 입니다. 
저자는 Krzysztof Cwalina와 Brad Abrams입니다.

 

www.informit.com/store/framework-design-guidelines-conventions-idioms-and-9780321545619

Framework Design Guidelines: Conventions, Idioms, and Patterns for Reusable .NET Libraries, 2nd Edition | InformIT

Framework Design Guidelines

 이 section에서는 .NET Framework와의 확장과 상호작용에 대한 libraries를 설계하기 위한 Guideline을 제공합니다. Guideline의 목적은 개발을 위해 사용되는 programming language와 독립적인 통일된 programming model을 제공하여  library designer들이 API 일관성과 사용 편의성을 보장하도록 돕는 것이다. .NET Framework를 확장하는 classes나 components를 개발할 때 이 design guidelines을 따르는 것을 권장한다. 일괄성없는 library design은 개발자의 생산성에 악영향을 주고 적용을 방해한다.

 guidelines은 'Do', 'Consider', 'Avoid' and 'Do not'이라는 접미사가 추가된 단순한 권장 사항으로 구성되어 있다. 이 guidelines들은 class library designers가 서로 다른 solution들 사이에서 trade-offs(장단점)를 이해하도록 돕는다. 적절한 library design을 위해 이 규칙들을 위반해야 하는 상황이 있을 수도 있다. 그런 경우는 드물며, 결정에 대해 분명하고 적절한 이유를 갖고 있는 것이 중요하다.

1.Naming Guidelines

2.Type Design Guidelines

3.Member Design Guidelines

4.Designing for Extensibility

5.Design Guidelines for Exceptions

6.Usage Guidelines

7.Common Design Patterns

 

docs.microsoft.com/en-us/dotnet/standard/design-guidelines/

Framework Design Guidelines