c# - 带有模糊引用的文档方法-摘要

Question

我有一个大量重载的方法 MethodA，它由我的 MethodB 文档中的摘要标记引用:

/// <summary>A link to <see cref="MethodA" /></summary>
void MethodB { ... }

注释不应仅依赖于 MethodA 的特殊重载，而应依赖于所有方法。但是，编译器会打印出 cref 属性不明确的消息(这是有意为之的)。是否有解决此问题的最佳做法？我已经考虑过从 summary 中完全删除 see 标签。也许您还有其他一些方法？

Answer 1

我认为您有 2 个选择。要么引用评论中的具体方法:

/// <summary>A link to <see cref="MethodA(int)" /> or one of it's overloaded variants</summary>

或者，您可以添加 M: prefix这将消除错误，但可能不是您所需要的:

/// <summary>A link to <see cref="M:MethodA" /></summary>