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

发布于 2024-08-30 21:37:43 字数 260 浏览 6 评论 0原文

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

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

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

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.

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(2

我的黑色迷你裙 2024-09-06 21:37:43

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

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

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

The prefixes F, M and E are all valid and probably the reason that the compiler warning disappears.

You should however use the F that refers to fields. For more information on how Visual Studio generates documentation identifiers see:

Processing the XML File (C# Programming Guide)

傾旎 2024-09-06 21:37:43

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

I don't think you should need the prefix - probably you need to add a "using" to the namespace where the Orientation type is defined.

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文