如何在c#xml docs中引用枚举常量

时间:2010-04-30 14:11:33

标签: c# documentation enums xml-documentation

我想记录枚举类型字段的默认值:

/// <summary>
/// The default value is <see cref="Orientation.Horizontal" />.
/// </summary>
public Orientation BoxOrientation;

编译器警告它无法解析引用。前缀F:或M:使编译器静音,但E:也是如此,所以我不确定哪个前缀是正确的。

2 个答案:

答案 0 :(得分:10)

前缀FME都有效,可能是编译器警告消失的原因。

但是,您应该使用引用字段的F。有关Visual Studio如何生成文档标识符的详细信息,请参阅:

Processing the XML File (C# Programming Guide)

答案 1 :(得分:0)

我认为您不应该需要前缀 - 可能需要在定义Orientation类型的命名空间中添加“using”。