c# - 如何在 c# xml 文档中引用枚举常量

标签 c# documentation enums xml-documentation

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

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

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

最佳答案

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

不过,您应该使用引用字段的 F。有关 Visual Studio 如何生成文档标识符的更多信息,请参阅:

Processing the XML File (C# Programming Guide)

关于c# - 如何在 c# xml 文档中引用枚举常量,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/2745043/

相关文章:

swift - 我如何在 Swift 4 中测试具有关联值的枚举案例的等效性

c# - 如何配置 Visual Studio 2017 android 模拟器以在本地主机上工作

c# - 在 C# 中异步创建新 DocumentDB 文档的问题

c# - 将单元测试代码写入 XML Comment

javascript - 如何阅读 Javascript 文档?

java - Eclipse JDT ASTParser 错误地转换枚举声明节点

enums - 如何在 Rust 中定义 "overlapping"枚举?

c# - 从 TFS 单元测试覆盖范围中排除文件夹

c# - 无法使用 Exchange Web 服务删除 session

java - 在 JavaDoc 中记录 setter/getter、属性和构造函数时,有没有办法避免文档重复?