c# - 文档方法摘要，引用不明确

Question

我有一个大量重载的方法MethodA，在我的文档中的 summary-tag 引用了该方法MethodB：

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

评论不仅应该依赖于它们的特殊重载，MethodA而且应该依赖于所有这些重载。但是，编译器会打印出 cref 属性不明确的消息（但这是有意的）。是否有解决此问题的最佳实践？我已经考虑see过从summary. 也许您还有其他方法？

score 0 · Accepted Answer

我认为你有两个选择。要么参考评论中的特定方法：

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

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

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

1 回答 1