.NET Code Documentation

Although good naming and a set of well written tests  can bring us so far, good documentation is sometimes indispensible.

Before releasing a component I was documenting a public API using the Visual Studio XML documentation. The exposed API was using generics, but I didn’t know what the correct documentation structure was.

MSDN brought the answer:

	/// <summary>
	/// GenericClass.
	/// </summary>
	/// <remarks>
	/// This example shows how to specify the <see cref="GenericClass{T}"/> type as a cref attribute.
	/// </remarks>
	class GenericClass<T>
	{
	// Fields and members.
	}

view raw CodeDocumentationGenerics.cs hosted with ❤ by GitHub