En xml doc, ¿puedo insertar una referencia a un grupo de métodos? ¿Cómo?
-
05-07-2019 - |
Pregunta
En C #, puedo adjuntar documentación para propiedades, métodos, eventos, etc. directamente en el código usando Comentarios de documentación XML .
Sé cómo insertar una referencia a un método en particular:
<see cref="MethodName(TypeForArg1, TypeForArg2..)"/>
¿Hay alguna forma de insertar una referencia a un grupo de métodos ? Donde tengo varias sobrecargas del mismo nombre de método ...
Lo intenté
<see cref="M:MethodName"/>
..pero eso no funcionó.
EDITAR: BUMP
Solución
Aparentemente no hay manera de hacer esto.
Otros consejos
Parece que esto se solucionó al menos en Visual Studio 2012:
<see cref="MethodName"/>
Generará una advertencia:
Referencia ambigua en el atributo cref: 'MethodName'. Suponiendo '& # 8230;', pero también podría haber coincidido con otras sobrecargas que incluyen '& # 8230;'.
Pero agregando un M:
al frente, deshazte de la advertencia:
<see cref="M:MethodName"/>
Para hacer referencia a un grupo de métodos, se requiere la siguiente sintaxis:
/// <summary>
/// Reference to a method group with two items:
/// <see cref="O:Full.Declaring.Namespace.TypeName.Foo"/>
/// </summary>
void Foo() { }
void Foo(int x) { }
Tenga en cuenta que esta sintaxis todavía tiene algunas limitaciones, como se describe en esta solicitud de función de lenguaje C # .
- La sintaxis no se valida durante la compilación. Los errores cometidos mientras se escribe no se informan hasta que / cuando Sandcastle Help File Builder procesa los comentarios.
- La sintaxis solo funciona si hay más de un método con el mismo nombre.
- No hay soporte de resaltado o edición de sintaxis para esta sintaxis.