O comentário da documentação XML .net inclui a diretiva no sandcastle que não é adicionada ao arquivo de ajuda

Question

Tenha um interessante.Estou documentando um método usando comentários de documentação XML em C#.Quero usar a diretiva para incluir todo o conteúdo de um arquivo referenciado.Estou documentando um trecho de código que recebe uma string formatada como um documento xml e quero incluir o arquivo XSD na documentação do parâmetro.

Isso funciona bem porque o XML gerado pelo Visual Studio é o esperado.Aqui está um trecho do XML:

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

No entanto, quando uso o Sandcastle para gerar um arquivo de ajuda a partir disso, o conteúdo do arquivo xsd não é mostrado, mas o Sandcastle não relata nenhum erro.Tentei usar o nome do arquivo em relação à localização dos arquivos de ajuda, ou seja,

mas o Visual Studio reclama que não consegue encontrar o arquivo.Coloquei-os nos dois lugares e mesmo assim o arquivo incluído não aparece.

Alguma ideia?

Answer 1

A tag include é processada em tempo de compilação, portanto o arquivo XML gerado deve conter todo o seu conteúdo referido.Portanto, você deve colocar sua pasta XSD em relação ao arquivo de origem C#, então o compilador não mostrará nenhum erro.Depois disso, o Sandcastle poderá criar o arquivo de ajuda a partir de um único documento XML.