<include>(Guia de programação translation from VPE for Csharp)
<include file='filename' path='tagpath[@name="id"]' />
Parâmetros
filename
O nome do arquivo que contém a documentação.nome de arquivo pode ser qualificado com um caminho.Coloque filename aspas simples (' ').tagpath
O caminho das Rótulos no filename Isso leva a marca name. Coloque o caminho entre aspas simples (' ').name
O especificador de nome na marca que precede os comentários; name terá um id.id
A ID de marca que precede os comentários.Coloque a ID entre aspas duplas ("").
Comentários
A marca <include>permite que você consulte comentários em outro arquivo que descrevem os tipos e membros em seu código-fonte.Essa é uma alternativa para colocar comentários de documentação diretamente em seu arquivo de código-fonte.
A marca <include>usa a sintaxe XML XPath.Consulte a documentação do XPath para formas de personalizar seu uso <include>.
Exemplo
Este é um exemplo de vários arquivos.O primeiro arquivo, que usa <include>, está listado abaixo:
// compile with: /doc:DocFileName.xml
/// <include file='xml_include_tag.doc' path='MyDocs/MyMembers[@name="test"]/*' />
class Test
{
static void Main()
{
}
}
/// <include file='xml_include_tag.doc' path='MyDocs/MyMembers[@name="test2"]/*' />
class Test2
{
public void Test()
{
}
}
O segundo arquivo, xml_include_tag.doc, contém os comentários de documentação a seguir:
<MyDocs>
<MyMembers name="test">
<summary>
The summary for this type.
</summary>
</MyMembers>
<MyMembers name="test2">
<summary>
The summary for this other type.
</summary>
</MyMembers>
</MyDocs>
Saída de programa
<?xml version="1.0"?>
<doc>
<assembly>
<name>xml_include_tag</name>
</assembly>
<members>
<member name="T:Test">
<summary>
The summary for this type.
</summary>
</member>
<member name="T:Test2">
<summary>
The summary for this other type.
</summary>
</member>
</members>
</doc>