¿Cómo vincular/sobrecargar grupos en comentarios de C# XML?

Question

En documentos XML comentarios para C#, ¿hay alguna manera de marcar dos o más funciones como sobrecargas, para que se refieran entre sí automáticamente? Idealmente, también se agruparían en la documentación generada por el castillo de arena de alguna manera.

Propósito: A menudo, deseo hacer un enlace a este grupo de funciones, p. en una lista de funciones de utilidad, solo mencione una de las sobrecargas y haga que las otras sean fácilmente detectables desde allí.

Actualmente estoy agregando enlaces, pero eso es tedioso.

Answer 1

La relación entre múltiples sobrecargas ya está identificada y agrupada por la documentación XMl y Sandcastle.

Crear enlaces a otros miembros utilizando las etiquetas see o seealso.

Por ejemplo.

///See <see cref="M:AnotherMethod(System.String)"> 

que he encontrado sin embargo que la resolución miembro de castillo de arena puede ser un poco extraño por lo que tienden a utilizar nombres completos.

///See <see cref="M:MyCompany.Myapp.MyClass.AnotherMethod(System.String)"> 

Nota M: indica que se está haciendo referencia un miembro, también se utiliza E: para que apunte a un evento. T: se usa para el tipo, pero eso se supone si no está presente.

Answer 2

agrupación se realiza automáticamente por Castillo de arena, bien, pero si usted quiere dar grupo sobrecarga de una descripción común, usar <sobrecargas> etiqueta para este (de la misma manera como <Resumen>). No es una etiqueta de documentación XML estándar, pero AFAIR es compatible con Sandcastle Help File Builder.