Evaluar y enviar comentarios
Contraer todo/Expandir todo Contraer todo
Esta página es específica de
Microsoft Visual Studio 2005/.NET Framework 2.0

Hay además otras versiones disponibles para:
Guía de programación de C#
<include> (Guía de programación de C#)

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

Parámetros

filename

Nombre del archivo que contiene la documentación. El nombre de archivo se puede completar con una ruta de acceso. Agregue filename entre comillas simples (' ').

tagpath

Ruta de acceso de las etiquetas de filename que conduce a la etiqueta name. Ponga la ruta de acceso entre comillas simples (' ').

name

Especificador de nombre en la etiqueta que precede a los comentarios; name poseerá un id.

id

Identificador para la etiqueta que precede a los comentarios. Ponga el id. entre comillas dobles (" ").

La etiqueta <include> permite hacer referencia a comentarios colocados en otro archivo que describen los tipos y miembros del código fuente. Ésta es una alternativa al método habitual de colocar los comentarios de la documentación directamente en el archivo de código fuente.

La etiqueta <include> utiliza la sintaxis XPath de XML. Consulte la documentación de XPath para conocer diversos modos de personalizar el uso de <include>.

Este ejemplo utiliza varios archivos. El primer archivo, que utiliza <include>, se muestra a continuación:

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

El segundo archivo, xml_include_tag.doc, contiene los siguientes comentarios de documentación:

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

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

Contenido de la comunidad   ¿Qué es Community Content?
Agregar contenido nuevo RSS  Anotaciones
Processing
© 2009 Microsoft Corporation. Reservados todos los derechos. Términos de uso | Marcas Registradas | Privacidad
Page view tracker