.NET XML Documentation Comment include la direttiva a Sandcastle che non si aggiunge al file di aiuto

Question

ha un interessante.Sto documentando un metodo usando i commenti della documentazione XML in C #.Voglio usare la direttiva per includere tutti i contenuti di un file di riferimento.Sto documentando un pezzo di codice che riceve una stringa formattata come documento XML e voglio includere il file XSD nella documentazione dei parametri.

funziona bene in questo XML generato da Visual Studio è come mi aspetto.Ecco uno snippet dell'XML:

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

.

Tuttavia, quando utilizzo Sandcastle per generare un file di aiuto da questo, i contenuti del file XSD non vengono visualizzati, ma Sandcastle non segnala alcun errore.Ho provato a utilizzare il nome del file come relativo a dove sono anche i file della guida, I.e.

.

Ma poi Visual Studio lamenta che non riesce a trovare il file.Li ho messi in entrambi i posti e ancora il file incluso non appare.

Qualche idea?

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.