<summary> (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 tipo.Use <remarks> para adicionar informações complementares para uma descrição de tipo.Use o atributo cref para habilitar ferramentas de documentação, como Sandcastle para criar hiperlinks internos para páginas de documentação para 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 Object Browser Window.
Compilar com /doc processo documentação comentários em um arquivo.Para criar a documentação final baseada 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 anterior produz o seguinte arquivo XML.
<?xml version="1.0"?>
<doc>
<assembly>
<name>YourNamespace</name>
</assembly>
<members>
<member name="T:DotNetEvents.TestClass">
text for class TestClass
</member>
<member name="M:DotNetEvents.TestClass.DoWork(System.Int32)">
<summary>DoWork is a method in the TestClass class.
<para>Here's how you could make a second paragraph in a description. <see cref="M:System.Console.WriteLine(System.String)"/> for information about output statements.</para>
<seealso cref="M:DotNetEvents.TestClass.Main"/>
</summary>
</member>
<member name="M:DotNetEvents.TestClass.Main">
text for Main
</member>
</members>
</doc>
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> { }
O exemplo anterior produz o seguinte arquivo XML.
<?xml version="1.0"?>
<doc>
<assembly>
<name>YourNamespace</name>
</assembly>
<members>
<member name="T:ExtensionMethodsDemo1.A">
<summary cref="T:ExtensionMethodsDemo1.C`1">
</summary>
</member>
<member name="T:ExtensionMethodsDemo1.B">
<summary cref="T:C`1">
</summary>
</member>
<member name="T:ExtensionMethodsDemo1.C`1">
<summary cref="T:ExtensionMethodsDemo1.A">
</summary>
<typeparam name="T"></typeparam>
</member>
</members>
</doc>
Consulte também
Referência
Marcas recomendadas para comentários da documentação (C# Guia de programação)