Compartilhar via

Como criar documentação XML no Visual Basic

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

Observação

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

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

  1. No Editor de Código, posicione o cursor na linha acima do tipo ou membro para o qual você deseja criar a documentação.

  2. Tipo ''' (três aspas simples).

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

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

    Observação

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

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

    O IntelliSense exibe o texto da tag <summary> do tipo ou membro.

  5. Compile o código para gerar um arquivo XML que contém os comentários da documentação. Para obter mais informações, consulte -doc.

Consulte também