【问题标题】:Document method-summary with ambigious reference引用不明确的文档方法摘要
【发布时间】: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 &lt;see cref="MethodA(int)" /&gt; or one of the overloads怎么样?
  • 这将仅依赖于 MethodB 特定的重载,而不是所有重载
  • 我知道,但我认为see cref 需要引用特定方法,而不是方法组。
  • 也许我会选择最常见的超载

标签: c# code-documentation


【解决方案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>

【讨论】:

  • 我不确定这是如何工作的,但它确实有效。 M: 如何解决歧义或无论如何?我只发现它引用了您链接中的方法。
  • 我相信当您使用前缀时,不再检查值是否存在,尽管我不是 100% 确定。
猜你喜欢
  • 1970-01-01
  • 2018-04-26
  • 2016-11-11
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2015-11-24
相关资源
最近更新 更多