Home > Store

Framework Design Guidelines: Conventions, Idioms, and Patterns for Reusable .NET Libraries (Paperback)

Register your product to gain access to bonus material or receive a coupon.

Framework Design Guidelines: Conventions, Idioms, and Patterns for Reusable .NET Libraries (Paperback)

Book

  • This product currently is not for sale.
Not for Sale

Description

  • Copyright 2009
  • Dimensions: 7" x 9-1/4"
  • Pages: 480
  • Edition: 1st
  • Book
  • ISBN-10: 0-13-483904-8
  • ISBN-13: 978-0-13-483904-2

Framework Design Guidelines, Second Edition, teaches developers the best practices for designing reusable libraries for the Microsoft .NET Framework. Expanded and updated for .NET 3.5, this new edition focuses on the design issues that directly affect the programmability of a class library, specifically its publicly accessible APIs.

This book can improve the work of any .NET developer producing code that other developers will use. It includes copious annotations to the guidelines by thirty-five prominent architects and practitioners of the .NET Framework, providing a lively discussion of the reasons for the guidelines as well as examples of when to break those guidelines.

Microsoft architects Krzysztof Cwalina and Brad Abrams teach framework design from the top down. From their significant combined experience and deep insight, you will learn

  • The general philosophy and fundamental principles of framework design
  • Naming guidelines for the various parts of a framework
  • Guidelines for the design and extending of types and members of types
  • Issues affecting—and guidelines for ensuring—extensibility
  • How (and how not) to design exceptions
  • Guidelines for—and examples of—common framework design patterns

Guidelines in this book are presented in four major forms: Do, Consider, Avoid, and Do not. These directives help focus attention on practices that should always be used, those that should generally be used, those that should rarely be used, and those that should never be used. Every guideline includes a discussion of its applicability, and most include a code example to help illuminate the dialogue.

Framework Design Guidelines, Second Edition, is the only definitive source of best practices for managed code API development, direct from the architects themselves.

Downloadable files can be found at the book’s web page. Included in these files are the Designing .NET Class Libraries video series and 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 and tools are (also included.


Sample Content

Table of Contents

Figures xvii

Tables xix

Foreword xxi

Foreword to the First Edition xxiii

Preface xxv

Acknowledgments xxxi

About the Authors xxxiii

About the Annotators xxxv

Chapter 1: Introduction 1

1.1: Qualities of a Well-Designed Framework 3

Chapter 2: Framework Design Fundamentals 9

2.1: Progressive Frameworks 11

2.2: Fundamental Principles of Framework Design 14

Chapter 3: Naming Guidelines 37

3.1: Capitalization Conventions 38

3.2: General Naming Conventions 46

3.3: Names of Assemblies and DLLs 54

3.4: Names of Namespaces 56

3.5: Names of Classes, Structs, and Interfaces 60

3.6: Names of Type Members 68

3.7: Naming Parameters 73

3.8: Naming Resources 74

Chapter 4: Type Design Guidelines 77

4.1: Types and Namespaces 79

4.2: Choosing Between Class and Struct 84

4.3: Choosing Between Class and Interface 88

4.4: Abstract Class Design 95

4.5: Static Class Design 97

4.6: Interface Design 98

4.7: Struct Design 101

4.8: Enum Design 103

4.9: Nested Types 115

4.10: Types and Assembly Metadata 118

Chapter 5: Member Design 121

5.1: General Member Design Guidelines 121

5.2: Property Design 138

5.3: Constructor Design 144

5.4: Event Design 153

5.5: Field Design 159

5.6: Extension Methods 162

5.7: Operator Overloads 168

5.8: Parameter Design 175

Chapter 6: Designing for Extensibility 193

6.1: Extensibility Mechanisms 193

6.2: Base Classes 206

6.3: Sealing 207

Chapter 7: Exceptions 211

7.1: Exception Throwing 216

7.2: Choosing the Right Type of Exception to Throw 221

7.3: Using Standard Exception Types 234

7.4: Designing Custom Exceptions 239

7.5: Exceptions and Performance 240

Chapter 8: Usage Guidelines 245

8.1: Arrays 245

8.2: Attributes 247

8.3: Collections 250

8.4: DateTime and DateTimeOffset 261

8.5: ICloneable 263

8.6: IComparable<T> and IEquatable<T> 264

8.7: IDisposable 266

8.8: Nullable<T> 266

8.9: Object 268

8.10: Serialization 274

8.11: Uri 283

8.12: System.Xml Usage 284

8.13: Equality Operators 286

Chapter 9: Common Design Patterns 289

9.1: Aggregate Components 289

9.2: The Async Patterns 298

9.3: Dependency Properties 312

9.4: Dispose Pattern 319

9.5: Factories 332

9.6: LINQ Support 337

9.7: Optional Feature Pattern 344

9.8: Simulating Covariance 348

9.9: Template Method 354

9.10: Timeouts 356

9.11: XAML Readable Types 358

9.12: And in the End... 361

Appendix A: C# Coding Style Conventions 363

A.1: General Style Conventions 364

A.2: Naming Conventions 367

A.3: Comments 368

A.4: File Organization 369

Appendix B: Using FxCop to Enforce the Framework Design Guidelines 371

B.1: What Is FxCop? 371

B.2: The Evolution of FxCop 372

B.3: How Does It Work? 373

B.4: FxCop Guideline Coverage 374

Appendix C: Sample API Specification 405

Glossary 413

Suggested Reading List 419

Index 423

Updates

Submit Errata

More Information

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020