2008-12-09 6 views
1

Je suis venu sur cette situation plusieurs fois auparavant. Je souhaite référencer un type dans mes commentaires XML, mais le type est contenu dans un assembly non référencé par mon projet.Lien vers un type non référencé par mon projet dans les commentaires XML?

En 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 {/*...*/} 

En 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 référence SomeClass mais je ne peux pas en raison du fait que 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 documentation de code LoserClass de cref, afin que A.SomeClass puisse être résolu par le générateur de documentation XML?

(BTW, vous ne pouvez pas toujours résoudre ce problème en cours en mouvement car il peut causer des dépendances circulaires dans d'autres endroits)

Répondre

1

Je ne connais pas une façon de le faire et je suis convaincu qu'il ne exister. La question est, pour quelle raison voulez-vous que vous vous référez dans les commentaires du composant B à A? B ne sait rien de A, non? A utilise B, donc cela a du sens pour moi, que les commentaires reflètent aussi cette dépendance. Mais l'inverse n'a aucun sens pour moi.

C'est juste mon humble avis,

Prensen

+0

Je ne veux pas entrer dans les détails à ce sujet, mais la raison pour laquelle ils sont dans cette configuration est pas parce qu'ils ne connaissent pas , c'est parce qu'ils doivent être pour éviter les références circulaires. Bien qu'ils n'interagissent pas directement les uns avec les autres, je veux documenter leur interaction dans les commentaires. – Will

+0

Je pense que cela se qualifie comme une odeur et je vais refactoriser cette idiotie en l'utilisant en combinant des assemblages qui n'auraient jamais dû être séparés en premier lieu. – Will