cref atributo (guia de programação C#)

O cref atributo em uma marca de documentação XML significa "código referência". Especifica que o texto interno da marca é um elemento de código, como, por exemplo, um tipo, método ou propriedade. Ferramentas de documentação como o Sandcastle usar o cref atributos para gerar automaticamente os hiperlinks para a página onde o tipo ou membro documentado.

Exemplo

A exemplo a seguir mostra um cref atributo usado em um <see> marca.

// Save this file as CRefTest.cs
// Compile with: csc CRefTest.cs /doc:Results.xml 

namespace TestNamespace
{
    /// <summary>
    /// TestClass contains two cref examples.
    /// </summary>
    public class TestClass
    {
        /// <summary>
        /// The GetZero method.
        /// </summary>
        /// <example> 
        /// This sample shows how to call the <see cref="GetZero"/> method.
        /// <code>
        /// class TestClass 
        /// {
        ///     static int Main() 
        ///     {
        ///         return GetZero();
        ///     }
        /// }
        /// </code>
        /// </example>
        public static int GetZero()
        {
            return 0;
        }

        /// <summary>
        /// The GetGenericValue method.
        /// </summary>
        /// <remarks> 
        /// This sample shows how to specify the <see cref="GetGenericValue"/> method as a cref attribute.
        /// </remarks>

        public static T GetGenericValue<T>(T para)
        {
            return para;
        }

        static int Main()
        {
            return GetZero();
        }
    }


    /// <summary>
    /// GenericClass.
    /// </summary>
    /// <remarks> 
    /// This example shows how to specify the <see cref="GenericClass{T}"/> type as a cref attribute.
    /// </remarks>
    class GenericClass<T>
    {
        // Fields and members.
    }
}

Quando compilado, o programa produz o seguinte arquivo XML. Observe que o primeiro cref atributo tenha sido transformado pelo compilador para "M:TestNamespace.TestClass.GetZero". "M" prefixo significa "método" e é uma convenção que é reconhecida pelas ferramentas de documentação como, por exemplo, Sandcastle. Para obter uma lista completa de prefixos, consulte Processamento XML Arquivo (guia de programação C#).

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>CRefTest</name>
    </assembly>
    <members>
        <member name="T:TestNamespace.TestClass">
            <summary>
            TestClass contains two cref examples.
            </summary>
        </member>
        <member name="M:TestNamespace.TestClass.GetZero">
            <summary>
            The GetZero method.
            </summary>
            <example> This sample shows how to call the <see cref="M:TestNamespace.TestClass.GetZero"/> method.
            <code>
            class TestClass 
            {
                static int Main() 
                {
                    return GetZero();
                }
            }
            </code>
            </example>
        </member>
        <member name="M:TestNamespace.TestClass.GetGenericValue``1(``0)">
            <summary>
            The GetGenericValue method.
            </summary>
            <remarks> 
            This sample shows how to specify the <see cref="M:TestNamespace.TestClass.GetGenericValue``1(``0)"/> method as a cref attribute.
            </remarks>
        </member>
        <member name="T:TestNamespace.GenericClass`1">
            <summary>
            GenericClass.
            </summary>
            <remarks> 
            This example shows how to specify the <see cref="T:TestNamespace.GenericClass`1"/> type as a cref attribute.
            </remarks>
        </member>
    </members>
</doc>

Consulte também

Referência

XML Documentation Comments (C# Programming Guide)

Recomendado marcas de comentários de documentação (C# guia de programação)

Histórico de alterações

Date	History	Motivo
Junho de 2010	O exemplo de revisado.	Comentários do cliente.