Como: criar documentação XML no Visual Basic
Este exemplo mostra como adicionar comentários de documentação XML a seu código.
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 de Visual Studio. |
Para criar documentação XML para um tipo ou membro
Na caixa Editor de códigos , posicione o cursor na linha acima do tipo ou membro para o qual você deseja criar documentação.
Tipo ''' (três aspas únicas).
Um esqueleto XML para o tipo ou membro é adicionado ao Editor de Códigos .
Adicione informações descritivas entre as marcas apropriadas.
Observação Se você adicionar linhas adicionais no bloco de documentação XML, cada linha deve começar com '''.
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.
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
Recomendado marcas XML para comentários da documentação (Visual Basic)