<resumo> (Guia de programação C#)
<summary>description</summary>
Parâmetros
- description
Um resumo do objeto.
Comentários
<summary> marca deve ser usada para descrever um tipo ou membro de um tipo. Use <remarks> para adicionar informações complementares para uma descrição do tipo. Use o cref atributo para habilitar as ferramentas de documentação, como Sandcastle para criar hiperlinks internos para páginas de documentação para os elementos de código.
O texto para <summary> marca é a única fonte de informações sobre o tipo de IntelliSense e também é exibida na Pesquisador de Objetos.
Compilar com /doc a comentários de documentação do processo para um arquivo. Para criar a documentação final com base no arquivo gerado pelo compilador, você pode criar uma ferramenta personalizada ou usar uma ferramenta como Sandcastle.
Exemplo
// compile with: /doc:DocFileName.xml
/// text for class TestClass
public class TestClass
{
/// <summary>DoWork is a method in the TestClass class.
/// <para>Here's how you could make a second paragraph in a description. <see cref="System.Console.WriteLine(System.String)"/> for information about output statements.</para>
/// <seealso cref="TestClass.Main"/>
/// </summary>
public static void DoWork(int Int1)
{
}
/// text for Main
static void Main()
{
}
}
O exemplo a seguir mostra como fazer uma cref referência a um tipo genérico.
// compile with: /doc:DocFileName.xml
// the following cref shows how to specify the reference, such that,
// the compiler will resolve the reference
/// <summary cref="C{T}">
/// </summary>
class A { }
// the following cref shows another way to specify the reference,
// such that, the compiler will resolve the reference
// <summary cref="C < T >">
// the following cref shows how to hard-code the reference
/// <summary cref="T:C`1">
/// </summary>
class B { }
/// <summary cref="A">
/// </summary>
/// <typeparam name="T"></typeparam>
class C<T> { }
Consulte também
Referência
Recomendado marcas de comentários de documentação (C# guia de programação)