<include> (Guia de programação C#)

Artigo
08/04/2011

<include file='filename' path='tagpath[@name="id"]' />

Parâmetros

filename
O nome do arquivo XML que contém a documentação. O nome do arquivo pode ser qualificado com um caminho. Coloque filename entre aspas simples (' ').
tagpath
O caminho das marcas em filename que leva a marca de name. Coloque o caminho entre aspas simples (' ').
name
O especificador de nome na marca que precede os comentários. nameterá um id.
id
A identificação de marca que precede os comentários. Coloque a identificação de aspas duplas (" ").

Comentários

O <include> marca permite que você consulte os comentários em outro arquivo que descrevem os tipos e membros em seu código-fonte. Esta é uma alternativa para colocar comentários de documentação diretamente no seu arquivo de código-fonte. Colocando a documentação em um arquivo separado, você pode aplicar o controle de origem para a documentação separadamente do código fonte. Uma pessoa pode ter um arquivo de código-fonte com check-out e a outra pessoa pode ter o check-out do arquivo de documentação.

O <include> marca usa a sintaxe XPath de XML. Consulte a documentação de XPath para maneiras de personalizar seu <include> Use.

Exemplo

Este é um exemplo de vários arquivos. O primeiro arquivo usa <include> está listada 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 do programa

A seguinte saída é gerada quando você compila as classes de teste e Test2 com a seguinte linha de comando: /doc:DocFileName.xml.No Visual Studio, você pode especificar a opção de comentários XML doc no painel Build do Project Designer. Quando o compilador C# vê <inclue> marca, ele irá procurar os comentários de documentação no xml_include_tag.doc em vez do arquivo de origem atual. Em seguida, o compilador gera DocFileName.xml e este é o arquivo que é consumido pelas ferramentas de documentação, como Sandcastle para produzir a documentação final.

<?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>

Consulte também

Referência

Conceitos

C# Programming Guide

Compartilhar via