Comment écrire une classe de sorte que les descriptions de la propriété et de la méthode sont visibles pour les personnes référencées de la DLL dans d'autres projets?
/// <summary>
/// My age in years attribute
/// </summary>
public int Age
{
get { return 0; }
set { }
}
4 Réponses :
La description fournie dans Pour les commentaires XML disponibles, vous devez Générez un fichier de documentation XML et expédiez-le avec votre assemblage. DescriptionAttribute est visible dans la grille de propriété à coup sûr et il n'a rien à voir avec l'éditeur de code.
dans Visual Studio:
Projet -> Propriétés -> Build -> Vérifiez "Fichier de documentation XML".
Pour plus de détails, voir Commentaires XML Vous permet de créer une documentation directement à partir de votre Visual Studio Fichiers source .NET .
Cela signifie-t-il que j'ai besoin de distribuer le XML avec la DLL et de les référer les deux? Y a-t-il quelque chose que je peux avoir toutes les informations de la DLL?
Non, les commentaires XML ne font partie de métadonnées de l'Assemblée.
@James: Vous pouvez intégrer le fichier XML de sortie en tant que ressource dans la DLL. Mais pourquoi voudriez-vous faire cela? Il existe déjà une façon parfaitement standard d'expédier les commentaires XML avec la DLL. Visual Studio s'intègre parfaitement aux fichiers XML qui sont générés par le processus décrit ci-dessus.
Merci Jason. Je travaille sur un projet in House afin que mes méthodes soient limitées. Restreindre les choses à une dll autonome avec XML intégré rend les choses plus gérables
@James: D'accord; assez juste. Content que je puisse aider.
Avez-vous créé le fichier de documentation Propriétés du projet -> Build -> [Sortie] Fichier de documentation XML
XML pour votre deuxième cas?
La seconde devrait fonctionner (résumé), assurez-vous de sélectionner dans le fichier de documentation XML Propriétés du projet (Build -> Sortie).
Votre deuxième fait travaille pour moi.
Peut-être que je manque quelque chose, mais les commentaires XML fonctionnent pour moi.
Le deuxième exemple fonctionne si le projet référençant la classe est dans la même solution. Je compile la classe en tant que DLL et référençant cette DLL. La DLL ne semble préserver aucun de l'attribut ou des informations résumées.