Como criar documentação XML no Visual Basic

  • Artigo

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

Observação

Seu computador pode mostrar diferentes nomes ou locais 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ê possui 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. Digite ''' (três aspas simples).

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

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

    Observação

    Se você adicionar linhas no bloco de documentação XML, cada uma delas 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 marca <summary> para o tipo ou membro.

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

Confira também