2009-11-23 6 views
2

disons que je classe A et classe définition de B. classe A est:.Comment puis-je lire la documentation d'une classe dans une autre classe?

/// <summary> 
/// This is the class documentation. 
/// </summary> 
public class A 
{ 
    /// <summary> 
    /// This is the documentation for attribute. 
    /// </summary> 
    public int attribute; 
    ... 
} 

Je veux accéder à la documentation de la classe A (à savoir les chaînes qui lisent « Ceci est la documentation de la classe. » Et ' C'est la documentation pour l'attribut. ') Dans la classe B par programme. Y a-t-il un moyen de faire cela? en utilisant la réflexion, peut-être?

Merci pour votre aide :)

Répondre

3

Je suppose que vous utilisez Visual Studio. Accédez aux paramètres de votre projet, définissez le chemin du fichier de documentation Xml. Lorsque vous compilez, les commentaires seront sauvegardés dans un fichier XML. Vous pouvez ensuite ouvrir le fichier par programmation et lire les commentaires

+1

Oui, c'est correct. Cliquez avec le bouton droit de la souris sur le projet, sélectionnez les propriétés, puis dans l'onglet "Build", cliquez sur la case à cocher "& XML documentation file:". Il devrait par défaut spécifier l'emplacement. De là, tous vos assemblys devraient avoir accès à ces commentaires par intellisense. – McKay

0

Générez le fichier de documentation XML et vous pouvez l'analyser par programme.

1

La documentation n'est pas exportée dans les assemblys de programme. Il est (éventuellement) extrait dans des fichiers XML séparés. Pour faire ce que vous suggérez, vous devez trouver ou écrire un outil qui analyse les fichiers XML et ajoute des métadonnées dans l'assemblage, ou expédier le fichier XML avec l'assemblage et y plonger lorsque vous souhaitez récupérer les Documentation.