. Adicionando documentação para o seu Visual Basic NET ( VB.NET ) projeto é importante para que as pessoas que utilizam o programa de ter um lugar para encontrar mais informações sobre os recursos que estão tendo problemas com. Visual Studio usa '' ' para significar uma linha de documentação, que ele cria automaticamente um modelo XML para . Quando você compila seu projeto, o Visual Studio irá criar um arquivo XML de todos os vossos comentários de documentação . Coisas que você precisa
Microsoft Visual Studio 2005, 2008 ou 2010
Show Mais instruções
1
Abra seu projeto VB.NET no Microsoft Visual Studio 2005, 2008 ou 2010 .
2
Localize o código para um tipo ou membro que você deseja documentar e colocar o cursor na linha acima do código. Um tipo inclui coisas como uma interface ou classe. Os membros incluem coisas como uma sub-rotina , função, evento ou propriedade.
3
Adicione '' ' ( três únicos personagens aspas ) para o início da linha . Isto especifica uma linha de documentação. O editor de código irá adicionar um esqueleto XML correspondente aos elementos na linha debaixo dela.
4
Adicione a sua documentação como texto entre as tags XML. É possível adicionar novas tags XML Documentação Comentário editando o arquivo " VBXMLDOC.xml " com um editor de texto. O arquivo está localizado na pasta ou do Visual Studio " Application Data " " AppData " .
5
Adicione as linhas extras de código com os comentários de documentação XML que usam o tipo ou membro. A tag vai mostrar informações adicionais sobre o tipo ou membro .
6 Clique seu projeto no Solution Explorer. Clique no menu " Project" e clique em " Propriedades". Clique na aba " Compile " e acrescentar " /doc " na caixa "Gerar arquivo de documentação XML" . Isso informa ao compilador para criar um arquivo XML quando você compilar o projeto .
7
Criar um arquivo de documentação XML através da compilação de seu projeto VB.NET . O arquivo será exibido na mesma pasta que o . Exe ou dll . .