Documentar o seu código com XML (Visual Basic)
Em Visual Basic, você pode documentar seu código usando XML
Comentários da Documentação XML
Visual Basic fornece uma maneira fácil de automaticamente criar documentação XML para projetos.Você pode gerar automaticamente um esqueleto XML para tipos e membros e, em seguida, fornecer resumos, documentação descritiva para cada parâmetro e outros comentários.Com a instalação apropriada, a documentação XML é emitida automaticamente em um arquivo XML com o mesmo nome do projeto e a extensão .xml.Para obter mais informações, consulte /doc.
O arquivo XML pode ser consumido ou manipulado como XML.Este arquivo está localizado no mesmo diretório que o arquivo de saída .exe ou .dll do projeto.
A documentação XML começa com '''.O processamento desses comentários tem algumas restrições:
A documentação deve ser XML bem formado.Se o XML não for bem formado, um aviso é gerado e o arquivo de documentação conterá um comentário informando que foi encontrado um erro.
Os desenvolvedores estão livres para criar seu próprio conjunto de marcas.Há um conjunto recomendado das marcas (consulte "Seções Relacionadas" neste tópico).Algumas das marcas recomendadas têm significado especial:
A marca <param> é usada para descrever os parâmetros.Se usado, o compilador verificará se o parâmetro existe e que todos os parâmetros estão descritos na documentação.Se a verificação falhar, o compilador emite um aviso.
O atributo cref pode ser anexado a qualquer marca para fornecer uma referência a um elemento de código.O compilador verifica se este elemento de código existe.Se a verificação falhar, o compilador emite um aviso.O compilador também respeita quaisquer instruções Imports ao procurar por um tipo descrito no atributo cref.
A marca <resumo> é usada pelo IntelliSense no Visual Studio para exibir informações adicionais sobre um tipo ou membro.
Seções relacionadas
Para obter detalhes sobre a criação de um arquivo XML com comentários de documentação, consulte os seguintes tópicos: