Partilhar via

Como: Criar documentação XML no Visual Basic

  • Artigo

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

Nota

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ê tem e as configurações que você usa determinam esses elementos. Para obter mais informações, consulte Personalizando o IDE.

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

  1. No 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 simples).

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

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

    Nota

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

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

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

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

Consulte também