Framework Design Guidelines: Conventions, Idioms, and Patterns for Reusable .NET Libraries [Hardcover]

Krzysztof Cwalina (Author), Brad Abrams (Author)

Book Description

ISBN-10: 0321246756 | ISBN-13: 978-0321246752 | Publication Date: September 29, 2005 | Edition: Har/Dvdr

A new edition of this title is available, ISBN-10: 0321545613 ISBN-13: 9780321545619

 

 

"This book is an absolute must-read for all .NET developers. It gives clear do and don't guidance on how to design class libraries for .NET. It also offers insight into the design and creation of .NET that really helps developers understand the reasons why things are the way they are. This information will aid developers designing their own class libraries and will also allow them to take advantage of the .NET class library more effectively."

--Jeffrey Richter, author/trainer/consultant, Wintellect

"Framework Design Guidelines will help you in two important ways. First, any .NET developer will benefit from a greater understanding of the design principles that govern the .NET Base Class Library. Second, a deeper understanding of these principles will help you to create software that integrates well with the .NET environment. Quite frankly, this book should be on every .NET developer's bookshelf."

--Bill Wagner, founder and consultant, SRT Solutions, author of Effective C#

"Not since Brooks' The Mythical Man Month has the major software maker of its time produced a book so full of relevant advice for the modern software developer. This book has a permanent place on my bookshelf and I consult it frequently."

--George Byrkit, senior software engineer, Genomic Solutions

"This book is a must-read for all architects and software developers thinking about frameworks. The book offers insight into some driving factors behind the design of the .NET Framework. It should be considered mandatory reading for anybody tasked with creating application frameworks."

--Peter Winkler, senior software engineer, Balance Technology Inc.

"Frameworks are valuable but notoriously difficult to construct: Your every decision must be geared towards making them easy to be used correctly and difficult to be used incorrectly. This book takes you through a progression of recommendations that will eliminate many of those downstream 'I wish I'd known that earlier' moments. I wish I'd read it earlier."

--Paul Besly, principal technologist, QA

"Filled with information useful to developers and architects of all levels, this book provides practical guidelines and expert background information to get behind the rules. Framework Design Guidelines takes the already published guidelines to a higher level, and it is needed to write applications that integrate well in the .NET area."

--Cristof Falk, software engineer

Framework Design Guidelines: Conventions, Idioms, and Patterns for Reusable .NET Libraries teaches developers the best practices for designing system frameworks and reusable libraries for use with the Microsoft .NET Framework and WinFX. This book focuses on the design issues that directly affect the programmability of a framework, specifically its publicly accessible APIs.

This book can improve the work of any .NET developer producing code that other developers will use. An added benefit is a collection of annotations to the guidelines by various members of the Microsoft .NET Framework and WinFX teams, which provide a lively discussion of the motives behind the guidelines, along with examples of good reasons for breaking the guidelines.

Microsoft architects Krzysztof Cwalina and Brad Abrams offer guidelines for framework design from the top down. From their long experience and deep insight, you will learn

• The general philosophy of framework design
• Principles and guidelines that are fundamental to overall framework design
• Naming guidelines for the various parts of a framework, such as namespaces, types, and members
• Guidelines for the design of types and members of types
• Issues and guidelines that are important to ensure appropriate extensibilityin your framework
• Guidelines for working with exceptions, the preferred error reporting mechanism in the .NET Framework and WinFX
• Guidelines for extending and using types that commonly appear in frameworks
• Guidelines for and examples of common framework design patterns

Guidelines in this book come in four major forms: Do, Consider, Avoid, and Do not. In general, a Do guideline should almost always be followed, a Consider guideline should generally be followed, an Avoid guideline indicates that something is generally not a good idea, and a Do not guideline indicates something you should almost never do. Every guideline includes a discussion of its applicability, and most guidelines include a code example.

A companion DVD includes the Designing .NET Class Libraries video series, instructional presentations by the authors on design guidelines for developing classes and components that extend the .NET Framework. A sample API specification and other useful resources are also included.

Editorial Reviews

From the Back Cover

A new edition of this title is available, ISBN-10: 0321545613 ISBN-13: 9780321545619

 

 

"This book is an absolute must-read for all .NET developers. It gives clear do and don't guidance on how to design class libraries for .NET. It also offers insight into the design and creation of .NET that really helps developers understand the reasons why things are the way they are. This information will aid developers designing their own class libraries and will also allow them to take advantage of the .NET class library more effectively."

--Jeffrey Richter, author/trainer/consultant, Wintellect

"Framework Design Guidelines will help you in two important ways. First, any .NET developer will benefit from a greater understanding of the design principles that govern the .NET Base Class Library. Second, a deeper understanding of these principles will help you to create software that integrates well with the .NET environment. Quite frankly, this book should be on every .NET developer's bookshelf."

--Bill Wagner, founder and consultant, SRT Solutions, author of Effective C#

"Not since Brooks' The Mythical Man Month has the major software maker of its time produced a book so full of relevant advice for the modern software developer. This book has a permanent place on my bookshelf and I consult it frequently."

--George Byrkit, senior software engineer, Genomic Solutions

"This book is a must-read for all architects and software developers thinking about frameworks. The book offers insight into some driving factors behind the design of the .NET Framework. It should be considered mandatory reading for anybody tasked with creating application frameworks."

--Peter Winkler, senior software engineer, Balance Technology Inc.

"Frameworks are valuable but notoriously difficult to construct: Your every decision must be geared towards making them easy to be used correctly and difficult to be used incorrectly. This book takes you through a progression of recommendations that will eliminate many of those downstream 'I wish I'd known that earlier' moments. I wish I'd read it earlier."

--Paul Besly, principal technologist, QA

"Filled with information useful to developers and architects of all levels, this book provides practical guidelines and expert background information to get behind the rules. Framework Design Guidelines takes the already published guidelines to a higher level, and it is needed to write applications that integrate well in the .NET area."

--Cristof Falk, software engineer

Framework Design Guidelines: Conventions, Idioms, and Patterns for Reusable .NET Libraries teaches developers the best practices for designing system frameworks and reusable libraries for use with the Microsoft .NET Framework and WinFX. This book focuses on the design issues that directly affect the programmability of a framework, specifically its publicly accessible APIs.

This book can improve the work of any .NET developer producing code that other developers will use. An added benefit is a collection of annotations to the guidelines by various members of the Microsoft .NET Framework and WinFX teams, which provide a lively discussion of the motives behind the guidelines, along with examples of good reasons for breaking the guidelines.

Microsoft architects Krzysztof Cwalina and Brad Abrams offer guidelines for framework design from the top down. From their long experience and deep insight, you will learn

• The general philosophy of framework design
• Principles and guidelines that are fundamental to overall framework design
• Naming guidelines for the various parts of a framework, such as namespaces, types, and members
• Guidelines for the design of types and members of types
• Issues and guidelines that are important to ensure appropriate extensibilityin your framework
• Guidelines for working with exceptions, the preferred error reporting mechanism in the .NET Framework and WinFX
• Guidelines for extending and using types that commonly appear in frameworks
• Guidelines for and examples of common framework design patterns

Guidelines in this book come in four major forms: Do, Consider, Avoid, and Do not. In general, a Do guideline should almost always be followed, a Consider guideline should generally be followed, an Avoid guideline indicates that something is generally not a good idea, and a Do not guideline indicates something you should almost never do. Every guideline includes a discussion of its applicability, and most guidelines include a code example.

A companion DVD includes the Designing .NET Class Libraries video series, instructional presentations by the authors on design guidelines for developing classes and components that extend the .NET Framework. A sample API specification and other useful resources are also included.

About the Author

Krzysztof Cwalina is a Program Manager on the Common Language Runtime team at Microsoft Corporation. He began his career at Microsoft designing APIs for the first release of the .NET Framework. He has been responsible for several namespaces in the Framework, including System.Collections, System.Diagnostics, System.Messaging, and others. He was also one of the original members of the FxCop team. Currently, he is leading a companywide effort to develop, promote, and apply the design guidelines to the .NET Framework and WinFX. Krzysztof graduated with a B.S. and an M.S. in computer science from the University of Iowa.

Brad Abrams was a founding member of both the Common Language Runtime and .NET Framework teams at Microsoft, where he is currently a Lead Program Manager. Brad has been involved with WinFX and Windows Vista efforts from the beginning. His primary role is to ensure consistency and developer productivity of the .NET Framework through Vista and beyond. His popular blog can be found at http://blogs.msdn.com/BradA/.

See all Editorial Reviews

Product Details

• Hardcover: 384 pages
• Publisher: Addison-Wesley Professional; Har/Dvdr edition (September 29, 2005)
• Language: English
• ISBN-10: 0321246756
• ISBN-13: 978-0321246752
• Product Dimensions: 7.2 x 1.2 x 9.4 inches
• Shipping Weight: 2 pounds
• Average Customer Review: 4.8 out of 5 stars  See all reviews (32 customer reviews)
• Amazon Best Sellers Rank: #671,719 in Books (See Top 100 in Books)
  • #14 in Books > Computers & Technology > Programming > Software Design, Testing & Engineering > Software Reuse

Customer Reviews

Most Helpful Customer Reviews

46 of 50 people found the following review helpful:

4.0 out of 5 stars Good reference of known material, September 30, 2005

By 

Mark Seemann (Copenhagen, Denmark) - See all my reviews
(REAL NAME)   

This review is from: Framework Design Guidelines: Conventions, Idioms, and Patterns for Reusable .NET Libraries (Hardcover)

Depending on your experience with the .NET framework, you may consider the contents of this book as everything from invaluable insights to mildly amusing explanations of a few details of .NET you've always wondered about.

Krzysztof Cwalina and Brad Abrams have worked with designing the public API of the .NET framework from its beginning, and during that process they have compiled a comprehensive guideline for framework design. It is basically this internal guideline they are now publishing as a book.

The text is easy to read and makes for a good reference book. It is littered with more free-form comments from lots of other experts such as Jeffrey Richter, Christopher Brumme, and the occasional comment from Anders Hejlsberg. However, it is mostly reminiscent of a Word document with lots of revision comments liberally sprinkled all over, and I suspect this is how book was made: Take an internal guideline document and polish it off; pass it around to a lot of collegues in Microsoft and ask them to comment on it; incorporate most comments verbatim in the text; and publish.

That said, I still found myself using lots of the little insights in the book in my work in the weeks after having read it. Most of those insights actually came from the free-form comments, so I'm not complaining.

If you use FxCop and are familiar with many of the rules in this tool, most of the guidelines in this book will come as no surprise to you. FxCop was originally a project of Krzysztof's and Brad's designed to automate much of their code review work, so you can learn most of the contents of this book just by using FxCop.

As such, almost all the guidelines in the book are publicly known material, but it's still a well organized reference, and the little extra comments from the authors and lots of other people are what made this book a worthwhile read for me.

I wouldn't consider this book essential reading for .NET developers, but it basically supplements FxCop pretty well.

31 of 33 people found the following review helpful:

5.0 out of 5 stars Nothing less than wisdom distilled, November 7, 2005

By 

John Gossman (Seattle, wa USA) - See all my reviews
(REAL NAME)   

This review is from: Framework Design Guidelines: Conventions, Idioms, and Patterns for Reusable .NET Libraries (Hardcover)

At Microsoft I work on a development team that has been using the guidelines from this book for nearly 4 years. I am not always a fan of coding standards, thinking they are a necessary evil, often simply arbitrary choices made for consistency.

The Framework Design Guidelines are different. These ensure deep consistency across not just source code, but more importantly the public classes themselves. They include critical, not to be ignored rules on security, cross-language access and localization, as well as the usual good practice type guidelines. But even these "good" practices are always backed with well reasoned argument and examples. As an added bonus FxCop provides a static analysis tool that enforces the guidelines.

Finally, the Framework Design Guidelines provide deep insight into how the .NET Frameworks are designed and used. With the guidelines in mind it is far easier to remember or even guess what classes are provided and how they should be used. This just makes the libraries that much more productive.

Full disclosure: I know Brad and Krzysztof personally, but I would simply remain silent if I didn't think highly of the work.

7 of 7 people found the following review helpful:

4.0 out of 5 stars Must-own book for any class library developer., October 17, 2005

By 

M. Icaza (Boston, MA USA) - See all my reviews
(REAL NAME)   

This review is from: Framework Design Guidelines: Conventions, Idioms, and Patterns for Reusable .NET Libraries (Hardcover)

The new book from Brad Abrams and Krzysztof Cwalina is a must-have book for anyone writing .NET and Mono code.


The book includes many of the design guidelines that Brad's blog is famous for. The book is not just a collection of rules, but it also includes the rationale for some of the design decisions and what really makes the book interesting are the commentaries from other developers and architects involved in .NET.

This book is packed with gems.