Comment lier/grouper les surcharges dans les commentaires XML C#?

Question

Dans les commentaires de document XML sur C#, existe-t-il un moyen de marquer deux fonctions ou plus comme étant des surcharges les unes des autres, afin qu'elles se référencent automatiquement l'une l'autre? Idéalement, ils seraient également regroupés dans la documentation générée par les châteaux de sable. Objectif: Souvent, je veux lier à ce groupe de fonctions, par ex. dans une liste de fonctions d'utilitaires, mentionnez simplement l'une des surcharges et faites en sorte que les autres soient facilement identifiables à partir de là.

Actuellement j'ajoute des liens, mais c'est fastidieux.

Answer 1

La relation entre plusieurs surcharges est déjà identifiée et regroupée par la documentation XMl et Sandcastle.

Création de liens vers d'autres membres à l'aide des tags see ou seealso.

Par exemple.

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

J'ai trouvé que cette résolution membre Sandcastle peut être un peu squameuse donc je tendance à utiliser des noms qualifiés. Notez le M: ​​indique qu'un membre est référencé, vous utilisez également E: pour pointer vers un événement. T: est utilisé pour le type mais est supposé s'il n'est pas présent.

Answer 2

le regroupement est fait automatiquement par Sandcastle, à droite, mais si vous voulez donner un groupe de surcharge une description commune, utilisez < > balise pour surcharge cela (de la même manière que < résumé >). Ce n'est pas une balise de documentation XML standard, mais AFAIR est pris en charge par Sandcastle Help File Builder.