.NET XML Documentation Commenter Inclure la directive dans Sandcastle n'ayant pas ajouté au fichier d'aide

Question

avoir une intéressante.Je documente une méthode utilisant XML Documentation Commentaires dans C #.Je souhaite utiliser la directive pour inclure tout le contenu d'un fichier référencé.Je documente un élément de code qui reçoit une chaîne formatée sous forme de document XML et je souhaite inclure le fichier XSD dans la documentation des paramètres.

Cela fonctionne bien en ce que le XML généré par Visual Studio est que je m'attends.Voici un extrait de la XML:

    /// <param name="xml">XML string - see Test.xsd <include file="XSD/Test.xsd" path="/*"/> After file include</param>

Cependant, lorsque j'utilise Sandcastle pour générer un fichier d'aide à partir de celui-ci, le contenu du fichier XSD n'est pas affiché, mais Sandcastle ne signale aucune erreur.J'ai essayé d'utiliser le nom de fichier comme relatif où les fichiers d'aide sont aussi bien, c'est-à-dire

Mais alors Visual Studio se plaint Il ne peut pas trouver le fichier.Je les ai mis dans les deux endroits et toujours le fichier inclus n'apparaît pas.

Des idées?

Answer 1

The include tag is processed at compiler time, so the generated XML file should contain all of its referred contents. Hence you have to put your XSD folder relative to the C# source file, then the compiler won't show any errors. After this, Sandcastle will be able to create the help file from the single XML document.