【发布时间】:2015-05-29 12:46:03
【问题描述】:
我有一个大规模重载的方法MethodA,它在我的MethodB 文档中的摘要标记中引用:
/// <summary>A link to <see cref="MethodA" /></summary>
void MethodB { ... }
评论不仅应该依赖于MethodA 的特殊重载,而且应该依赖于所有这些。但是,编译器会打印出 cref 属性不明确的消息(但这是有意的)。是否有解决此问题的最佳实践?我已经想过从summary 中完全删除see-tag。也许您还有其他方法?
【问题讨论】:
-
说
A link to <see cref="MethodA(int)" /> or one of the overloads怎么样? -
这将仅依赖于
MethodB特定的重载,而不是所有重载 -
我知道,但我认为
see cref需要引用特定方法,而不是方法组。 -
也许我会选择最常见的超载
标签: c# code-documentation