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

Question

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

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

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

Answer 1

前缀F,M并且E都是有效的,可能是编译器警告消失的原因.

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

处理XML文件(C#编程指南)