Compartilhar via

Documentar seu código com XML (Visual Basic)

No Visual Basic, você pode documentar seu código usando XML.

Comentários da documentação XML

O Visual Basic fornece uma maneira fácil de criar automaticamente a documentação XML para projetos. Você pode gerar automaticamente um esqueleto XML para seus tipos e membros e, em seguida, fornecer resumos, documentação descritiva para cada parâmetro e outras observações. Com a configuração apropriada, a documentação XML é emitida automaticamente em um arquivo XML com o mesmo nome de arquivo raiz que o projeto. Para obter informações sobre como configurar a geração do arquivo de documentação XML, consulte a opção do compilador -doc e a propriedade GenerateDocumentationFile MSBuild.

O arquivo XML pode ser consumido ou manipulado como XML. Esse arquivo está localizado no mesmo diretório que o arquivo de saída .exe ou .dll do seu projeto.

A documentação XML começa com '''. O processamento desses comentários tem algumas restrições:

  • A documentação deve ser XML bem formada. Se o XML não estiver bem formado, um aviso será gerado e o arquivo de documentação conterá um comentário informando que um erro foi encontrado.

  • Os desenvolvedores são livres para criar seu próprio conjunto de marcas. Há um conjunto recomendado de tags (consulte tags XML de comentário). Algumas das etiquetas recomendadas têm significados especiais.

    • A marca <param> é usada para descrever parâmetros. Se usado, o compilador verificará se o parâmetro existe e se todos os parâmetros são descritos na documentação. Se a verificação falhar, o compilador emitirá um aviso.

    • O atributo cref pode ser anexado a qualquer tag para fornecer uma referência a um elemento de código. O compilador verifica se esse elemento de código existe. Se a verificação falhar, o compilador emitirá um aviso. O compilador também respeita todas as declarações Imports ao procurar por um tipo descrito pelo atributo cref.

    • A <marca de resumo> é usada pelo IntelliSense no Visual Studio para exibir informações adicionais sobre um tipo ou membro.

Para obter detalhes sobre como criar um arquivo XML com comentários de documentação, consulte os seguintes tópicos:

Consulte também