Referencing another class in documentation
suggest changeThe <see>
tag can be used to link to another class. It contains the cref
member which should contain the name of the class that is to be referenced. Visual Studio will provide Intellsense when writing this tag and such references will be processed when renaming the referenced class, too.
/// <summary>
/// You might also want to check out <see cref="SomeOtherClass"/>.
/// </summary>
public class SomeClass
{
}
In Visual Studio Intellisense popups such references will also be displayed colored in the text.
To reference a generic class, use something similar to the following:
/// <summary>
/// An enhanced version of <see cref="List{T}"/>.
/// </summary>
public class SomeGenericClass<T>
{
}
Found a mistake? Have a question or improvement idea?
Let me know.
Table Of Contents