Référence dans la documentation Prefixes XML .NET

Question

Je suis tenté de documenter tous les types, les méthodes, les propriétés, etc., d'une bibliothèque de classes en utilisant les commentaires XML, mais se sont heurtées à un effet curieux impliquant l'attribut cref (utilisé par les balises see par exemple). En passant par les conseils de cette page MSDN ainsi que divers autres suivant exemples sur MSDN et d'autres sites, il semble que chaque fois on spécifie une valeur de référence en utilisant la balise cref, il doit être préfixé avec un certain marqueur qui classe le refence (comme « T: » pour le type et « M: » pour la méthode) .

Utilisation de Microsoft Sandcastle, cependant, j'ai observé qu'en manquant ces préfixes il y a un effet dans la documentation générée (fichier d'aide CHM dans ce cas). Y compris les préfixes (dans toutes les situations que je belive), la référence est rendu sur la page de texte en gras ... désocclusion Pourtant, le préfixe la référence est rendu comme une ancre (lien) à la page de la référence au sein correspond le API. Il semble assez étrange pour moi que la méthode recommandée de références (préfixer tous?) Donne le moindre résultat utile - pourquoi la référence rendue en gras dans un cas et lié dans un autre? Je vous serais reconnaissant si quelqu'un pouvait faire la lumière sur ce point.

Answer 1

Cela semble avoir été un bug Sandcastle

Quelle version de Sandcastle utilisez-vous?

Cela dit récentes discussions semblent indiquer que, au moins pour les types du système, la méthode proposée est d'éviter effectivement d'utiliser les noms qualifiés puisque les exemples posé dans cette réponse a chuté T: et M:. entièrement Votre confusion est donc pas inattendu ou rare

Cette documentation implique fortement que le compilateur, où il peut place ce que vous êtes de type / méthode / constante montrant insère les préfixes pour vous. Avez-vous vérifié cela dans le xml?