Como: criar documentação XML no Visual Basic

This example shows how to add XML documentation comments to your code.

Observação
Seu computador pode mostrar nomes ou locais diferentes para alguns dos elementos da interface do usuário do Visual Studio nas instruções a seguir. A edição do Visual Studio que você possui e as configurações que você usa determinam esses elementos. Para obter mais informações, consulte Configurações do Visual Studio.

To create XML documentation for a type or member

1. In the Code Editor, position your cursor on the line above the type or member for which you want to create documentation.

2. Type ''' (three single-quotation marks).

   An XML skeleton for the type or member is added in the Code Editor.

3. Add descriptive information between the appropriate tags.

   Observação
   If you add additional lines within the XML documentation block, each line must begin with '''.

4. Add additional code that uses the type or member with the new XML documentation comments.

   IntelliSense displays the text from the <summary> tag for the type or member.

5. Compile the code to generate an XML file containing the documentation comments. For more information, see /doc.

Consulte também

Referência

Recomendado marcas XML para comentários da documentação (Visual Basic)

/doc

Conceitos

Documentando Seu Código com XML (Visual Basic)