带有暧昧参考的文档方法摘要

Question

我有一个大量重载的方法MethodA，我的MethodB文档中的摘要标记引用了该方法：

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

评论不仅应该依赖于MethodA的特殊重载，还应该依赖于所有这些重载。然而，编译器打印出amfssage，即cref属性是ambigious（但是它是有意的）。有没有最佳实践来解决这个问题？我已经考虑过从see中完全删除summary - 代码。也许你有其他方法吗？

Answer 1

我认为你有两种选择。请参阅注释中的特定方法：

/// <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>