C#,XmlDoc:如何引用方法重载

时间:2009-08-18 12:42:51

标签: c# overloading xml-documentation

如果我有这两种方法

public Foo Get(string bar) { ... }
public Foo Get(int bar) { ... }

并使用不同的方法编写这段xml文档

/// <summary>
/// Has a close relation to the <see cref="Get"/> methods.
/// </summary>

我在Get下得到一个蓝色波浪形,说它是一个不明确的参考'Get'。这是真的,但我希望它引用两者。这样做的正确方法是什么?或者我应该只引用单个方法重载?

2 个答案:

答案 0 :(得分:18)

尝试

/// Has a close relation to the <see cref="Get(string)"/>  
/// and <see cref="Get(int)" /> methods.

您可能需要完整的姓名,但只要您放入第一个括号,intellisense就会有所帮助。

希望有所帮助,

答案 1 :(得分:3)

这是旧问题的更新答案。我不确定这是什么时候有效,因为那里没有太多文件。如果您在cref前加"o:..."属性,例如在"o:myMethod()"中,它将链接到过载部分并覆盖该方法的所有重载。使用Daniel Elliott的回答示例:

/// Has a close relation to the <see cref="o:Get()"/> methods.  

这也将删除Intellisense / Resharper关于含糊不清的引用的警告。