Como criar documentação XML no Visual Basic

Este exemplo mostra como adicionar comentários de documentação XML a seu código.

Dica

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 Personalizando configurações de desenvolvimento no Visual Studio.

Para criar documentação XML para um tipo ou membro

1. Na caixa Editor de códigos , posicione o cursor na linha acima do tipo ou membro para o qual você deseja criar documentação.

2. Tipo ''' (três aspas únicas).

   Um esqueleto XML para o tipo ou membro é adicionado ao Editor de Códigos .

3. Adicione informações descritivas entre as marcas apropriadas.

   Dica

   Se você adicionar linhas adicionais no bloco de documentação XML, cada linha deve começar com '''.

4. Adicione código adicional que usa o tipo ou membro com os novos comentários de documentação XML.

   O IntelliSense exibe o texto da marca < resumo > para o tipo ou membro.

5. Compile o código para gerar um arquivo XML contendo comentários de documentação. Para obter mais informações, consulte /doc.

Consulte também

Referência

Marcas XML recomendadas para comentários da documentação (Visual Basic)

/doc

Conceitos

Documentando o código com XML (Visual Basic)