I want to document the default value of an enum typed field:
/// <summary>
/// The default value is <see cref="Orientation.Horizontal" />.
/// </summary>
public Orientation BoxOrientation;
The compiler warns that it couldn’t resolve the reference. Prefixing F: or M: silences the compiler, but E: also does, so I’m unsure what prefix is correct.
The prefixes
F,MandEare all valid and probably the reason that the compiler warning disappears.You should however use the
Fthat refers to fields. For more information on how Visual Studio generates documentation identifiers see:Processing the XML File (C# Programming Guide)