Jan 27

Já vimos em postagens anteriores como fazer a documentação do projeto gerado pelo GAS, entretanto, as vezes necessitamos de uma documentação mais completa das classes e demais itens de nosso projeto para uso da equipe de desenvolvimento ou outra finalidade.

Existem diversas ferramentas para isto, hoje vamos apresentar uma ferramenta simples que você pode utilizar para atingir este objetivo. A ferramenta é o VsDocMan.

A instalaçao do VsDocMan é bem simples e após instalada, ela incorpora ao Visual Studio, trazendo facilidade de uso, pois basta um click no botão respectivo para acessá-lo.

O GAS gera comentários para documentação em todas as funções criadas por ele, o que irá facilitar e muito no momento de usarmos o VsDocMan.

Abaixo um exemplo de como gerar a documentaçao de um projeto gerado pelo gas, em poucos segundos.

  1. Abra o projeto gerado no Visual Studio .NET.
  2. Carrege o VSdocman (se ele não estiver carregado): vá ao menu Add-Ins, e clique em Add-In Manager ..., selecione VSdocman e execute. Depois verá um novo item chamado VSdocman mostrando no menu Add-ins na barra de ferramenta padrão.

3 - Clicando no botão será exibido a tela, onde voce escolherá as opções desejadas, entre elas o formato de geração da documentação.

 

4 - Clicando em Compile, terá a geração da documentação. São vários formatos, inclusive no formato MSDN.

Até a próxima.

Add comment




biuquote
Loading