Chapter 8. Usage Guidelines

This chapter contains guidelines for using common types in publicly accessible APIs. It deals with direct usage of built-in Framework types (e.g., Collection<T>), implementing common interfaces, and inheriting from common base classes. The last section of the chapter talks about overloading common operators.

Arrays

This section presents guidelines for using arrays in publicly accessible APIs.

DO prefer using collections over arrays in public APIs. Section 8.3.3 describes details of how to choose between collections and arrays.

public class Order {
    public Collection<OrderItem> Items { get { ... } }
    ...
}

DO NOT use read-only array fields. The field itself is read-only and can’t be changed, but elements in the array can ...

Get Framework Design Guidelines: Conventions, Idioms, and Patterns for Reusable .NET Libraries now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.