Question

Je suis tombé sur cette situation plusieurs fois auparavant. Je souhaite référencer un type dans mes commentaires XML, mais ce type est contenu dans un assemblage non référencé par mon projet.

Dans A.Dll (références B.DLL):

using B;
///<summary>Hai I'm SomeClass and I use <seealso cref="B.LoserClass"/> to do my work</summary>
public class SomeClass {/*...*/}

Dans B.DLL (ne fait pas référence à A.DLL):

///<summary> I can't <seealso cref="A.SomeClass"/> in this summary </summary>
public class LoserClass {/*...*/}

Dans les commentaires pour LoserClass, je dois faire référence à SomeClass mais je ne peux pas, car B.DLL ne fait pas référence à A.DLL (référence circulaire).

Existe-t-il un moyen d'inclure les informations d'assemblage dans la cref dans la A.SomeClass 'documentation du code, afin que <=> puisse être résolu par le générateur de documentation XML?

(d'ailleurs, vous ne pouvez pas toujours résoudre ce problème en déplaçant des classes car cela peut entraîner des dépendances circulaires à d'autres endroits)

Était-ce utile?

La solution

Je ne connais pas le moyen de le faire et je suis convaincu que cela n'existe pas. La question qui se pose est la suivante: pour quelle raison voulez-vous que vous fassiez référence aux commentaires des composants B à A? B ne sait rien de A, non? A utilise B, il est donc logique que les commentaires reflètent également cette dépendance. Mais l'inverse n'a aucun sens pour moi.

C'est juste mon humble avis,

Prensen

Licencié sous: CC-BY-SA avec attribution
Non affilié à StackOverflow
scroll top