codedocs.md

Code Documentation Phrases

Introduction

This page is a collection of interesting phrases used in MSDN .NET documentation that can be used to help write your own source code documentation in a more user-friendly and consistent manner. The phrases are organized into the types of code elements they describe. Interesting parts of phrases have been emphasized in bold.

Perhaps in future this could serve as a basis for some kind of online/offline tool to assist in writing code documentation by suggesting common phrases.

Interfaces

• Defines methods to manipulate generic collections. - ICollection<T>
• Defines a method that a type implements to compare two objects. - IComparer<T>
• Exposes the enumerator, which supports a simple iteration over a collection of a specified type. - IEnumerable<T>
• Provides the base interface for the abstraction of sets. - ISet<T>
• Represents a generic collection of key/value pairs. - IDictionary<TKey, TValue>
• Supports a simple iteration over a generic collection. - IEnumerator<T>

Base Classes

• Provides a base class for implementations of the IComparer<T> generic interface. - Comparer<T>

Classes (General)

• Provides a collection whose items are types that serve as keys. - KeyedByTypeCollection<TItem>
• Provides a thread-safe collection that contains objects of a type specified by the generic parameter as elements. - SynchronizedCollection<T>
• Represents a collection of keys and values. - Dictionary<TKey, TValue>
• Represents a set of values. - HashSet<T>
• Represents a strongly typed list of objects that can be accessed by index. Provides methods to search, sort, and manipulate lists. - List<T>
• Represents a collection of key/value pairs that are sorted by key based on the associated IComparer<T> implementation. - SortedList<TKey, TValue>
• Represents a variable size last-in-first-out (LIFO) collection of instances of the same specified type. - Stack<T>

Exceptions

• The exception that is thrown when the key specified for accessing an element in a collection does not match any key in the collection. - KeyNotFoundException

Structures (General)

• Defines a key/value pair that can be set or retrieved. - KeyValuePair<TKey, TValue>

Enumerators (Structures)

• Enumerates the elements of a Dictionary<TKey, TValue>. - Dictionary<TKey, TValue>.Enumerator

Constructors

• Initializes a new instance of the List<T> class that is empty and has the default initial capacity. -'List.List()'
• Initializes a new instance of the List<T> class that is empty and has the specified initial capacity.. -'List.List(Int32)'

Methods

• Adds an item to the ICollection<T> - IList<T>.Add(T)
• Determines the index of a specific item in the IList<T>. - IList<T>.IndexOf(T)
• Determines whether the ICollection<T> contains a specific value. - IList<T>.Contains(T)
• Copies the elements of the ICollection<T> to an Array, starting at a particular Array index. - IList<T>.CopyTo(T[], Int32)

Properties

Read-Only Properties

• Gets the number of elements contained in the ICollection<T> - IList<T>.Count

Read-Write Properties

• Gets or sets the element at the specified index. - IList<T>.Item[Int32]

Boolean Properties

• Gets a value indicating whether the ICollection<T> is read-only. - IList<T>.IsReadOnly

Resources

• System.Collections.Generic namespace