<include> (Przewodnik programowania w języku C#)

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

Parametry

  • filename
    Nazwa pliku XML zawierającego dokumentacji.Nazwa pliku może zostać zakwalifikowany ze ścieżką.Należy ująć filename w znaki pojedynczego cudzysłowu (' ').

  • tagpath
    Ścieżka znaczniki w filename prowadzi to do znacznika name.Należy ująć ścieżkę w znaki pojedynczego cudzysłowu (' ').

  • name
    Specyfikator nazwy w tagu, który poprzedza uwag; namebędzie id.

  • id
    Identyfikator znacznika, który poprzedza komentarze.Należy ująć identyfikator w podwójny cudzysłów ("").

Uwagi

<include> tag pozwala odnoszą się do uwag w innym pliku, które opisują typy i członków w kodzie źródłowym.Jest to alternatywa dla wprowadzania komentarzy dokumentacji bezpośrednio w pliku kodu źródłowego.Umieszczając w dokumentacji w oddzielnym pliku, można zastosować kontroli źródła dokumentacji oddzielnie z kodu źródłowego.Jedna osoba może mieć wyewidencjonowany plik kodu źródłowego, a ktoś inny może mieć wyewidencjonowany plik dokumentacji.

<include> znacznik używa składni XML XPath.Zajrzyj do dokumentacji XPath sposoby dostosowywania programu <include> za pomocą.

Przykład

Jest to przykład multifile.Pierwszy plik, który używa <include>, została wymieniona poniżej:

// 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()
    {
    }
}

Drugi plik, xml_include_tag.doc, zawiera następujące uwagi dokumentacji:

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

Dane wyjściowe programu

Następujące dane wyjściowe jest generowany podczas kompilowania klas badania i Test2 przy użyciu następującego wiersza polecenia: /doc:DocFileName.xml. W Visual Studio, określono opcję Komentarze XML doc w okienku Build Project Designer.Gdy kompilator C# widzi <inclue> tag, przeszukiwane są dla komentarzy dokumentacji w xml_include_tag.doc zamiast bieżącego pliku źródłowego.Następnie kompilator generuje DocFileName.xml i jest to plik, który jest zużywany przez dokumentację narzędzia, takie jak Sandcastle do wyprodukowania ostatniej dokumentacji.

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

Zobacz też

Informacje

Znaczniki zalecane dla komentarzy do dokumentacji (Przewodnik programowania w języku C#)

Koncepcje

Przewodnik programowania w języku C#