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

Svi*_*ish 22 c# overloading xml-documentation

如果我有这两种方法

public Foo Get(string bar) { ... }
public Foo Get(int bar) { ... }
Run Code Online (Sandbox Code Playgroud)

并在不同的方法上编写这段xml文档

/// <summary>
/// Has a close relation to the <see cref="Get"/> methods.
/// </summary>
Run Code Online (Sandbox Code Playgroud)

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

Dan*_*ott 20

尝试

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

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

希望有所帮助,

  • 我真的希望有一些方法来做OP最初想要的东西.虽然这种方法在没有更好的方法的情况下是实用的,但它也是草率的,因为参数列表是_implementation detail_,它与实际的评论无关.如果在稍后的某个时候添加了第三个重载并且忘记了这个注释,那么它会错误地表明注释_doesn't_适用于新的重载,实际上它可能会这样做.(我想我已经看到了一个更接近的方法,但遗憾的是它不记得了.) (3认同)