valid - summary c# documentation

C#, XmlDoc: Cómo hacer referencia a sobrecargas de métodos

Question

Si tengo estos dos métodos

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

Y escribe esta pieza de documentación xml en un método diferente

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

Obtengo un garabato azul debajo de Get , diciendo que es una referencia ambigua ''Obtener'' . lo cual es cierto, pero quiero que haga referencia a ambos. ¿Cuál es la forma correcta de hacer esto? ¿O debo suponer que solo debo hacer referencia a una sobrecarga de un solo método?

Answer 1

Aquí hay una respuesta actualizada a esta vieja pregunta. No estoy seguro de cuándo se hizo válido porque no hay mucha documentación por ahí. Si cref un atributo cref con "o:..." como en "o:myMethod()" , se vinculará a la sección de sobrecarga y cubrirá todas las sobrecargas de ese método. Usando el ejemplo de respuesta de Daniel Elliott:

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

Esto también eliminará las advertencias de Intellisense / Resharper sobre referencias ambiguas.

Answer 2

Tratar

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

Es posible que necesite nombres de usuario completos, pero intellisense debería ayudar tan pronto como coloque el primer corchete.

Espero que ayude,

Dan