.NET XML Documentation Comment incluye la Directiva en Sandcastle que no se agrega para solicitar el archivo de ayuda

StackOverflow https://stackoverflow.com/questions/9510477

Pregunta

tener uno interesante.Estoy documentando un método utilizando los comentarios de documentación XML en C #.Quiero usar la directiva para incluir todos los contenidos de un archivo referenciado.Estoy documentando una pieza de código que recibe una cadena formateada como un documento XML, y quiero incluir el archivo XSD en la documentación del parámetro.

Esto funciona bien en que el XML generado por Visual Studio es lo que espero.Aquí hay un fragmento de XML:

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

Sin embargo, cuando uso Sandcastle para generar un archivo de ayuda de esto, no se muestran los contenidos del archivo XSD, pero Sandcastle no reporta errores.Intenté usar el nombre del archivo como en relación con el lugar donde los archivos de ayuda también son, es decir,

Pero luego, Visual Studio se queja, no puede encontrar el archivo.Los puse en ambos lugares y todavía el archivo incluido no aparece.

¿Alguna idea?

¿Fue útil?

Solución

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.

Licenciado bajo: CC-BY-SA con atribución
No afiliado a StackOverflow
scroll top