记录方法总结，并提供令人震惊的参考

本文关键字：参考 方法 记录 | 更新日期: 2023-09-27 17:51:04

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

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

注释不仅应该依赖于MethodA的特殊重载，而且应该依赖于所有这些重载。然而，编译器会打印一条消息，表明cref属性是模糊的(这是预期的(。有什么最佳实践可以解决这个问题吗？我已经考虑过从summary中完全删除see-标签。也许你还有其他方法？

记录方法总结，并提供令人震惊的参考

我认为您有两个选项。请参考注释中的特定方法：

/// <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>
相关文章：