VBdocman é um programa de geração automática de documentação técnica a partir dos seus ficheiros de origem Visual Basic com apenas alguns cliques de rato. Analisa o código-fonte e cria automaticamente uma tabela de conteúdos, índices, tópicos, referências cruzadas e ajuda sensível ao contexto. O formato da documentação de saída é totalmente configurável pelo utilizador. Os formatos de saída predefinidos são:
AJUDA HTML (ficheiro*.chm que se parece com MSDN)-
Ficheiros HTML (com índice java e tabela de conteúdos)
WinHelp (ficheiro*.hlp)
Documento RTF
XML
VBdocman funciona como um add-in na MS Visual Basic 6.0. Depois de invocar um simples diálogo através do menu principal e (no caso mais simples) clicar num botão, a documentação de saída especificada é gerada. Cria automaticamente todos os links interessantes, tais como Aplicações, Métodos, Eventos, Propriedades, Eventos, Tabela de Conteúdos e Índice. Em grandes projetos apenas este trabalho poupa muitos dias de trabalho aborrecido. A documentação pode então ser editada e descrição adicional ali dada como Ver Também, Links de Exemplos, objeto, método, descrição de propriedade ou evento, descrição de parâmetros e assim por diante. O VBdocman permite adicionar mesmo essa descrição automaticamente, extraindo-a do comentário de código fonte de tags especiais. Funciona da mesma forma que o sistema JavaDoc. Mas, o utilizador não é obrigado a escrever comentários manualmente, vBdocman adiciona-o apenas por dois cliques de rato. Todas as etiquetas necessárias são adicionadas e o utilizador preenche-lhes uma breve descrição. Além disso, fornece um editor de comentários sofisticado e fácil de usar.
Vantagens:
A consistência. Se algo foi adicionado ao código, por exemplo, novo método, é automaticamente refletido na documentação recém-gerada.
A documentação em vários formatos pode ser gerada por poucos cliques de rato. Portanto, tem documentação em todos os formatos suportados em poucos minutos.
Comunicação eficiente dentro da equipa, especialmente quando a Source Safe é utilizada. Todos os programadores comentam a sua parte do código.
história da versão
- Versão 2.25 postado em 2005-11-09
Saída melhorada e correções de erros.
Detalhes do programa
EULA
EULA - Contrato de Licença de Utilizador Final
CONTRATO DE LICENÇA VBDOCMAN
O Add-In VBdocman NÃO é de freeware. Isto significa:
Todos os direitos de autor da VBdocman são propriedade exclusiva do autor - Peter Macej (HELIXOFT).
Qualquer pessoa pode utilizar este software durante um período experimental de 14 dias.
Após este período experimental de 14 dias ou menos, se desejar continuar
para utilizar o VBdocman, deve registar-se (comprar). Quando compras o VBdocman, tornas-te
utilizador registado.
Existem seguintes tipos de licenças emitidas para a VBdocman:
1. Uma única licença de UTILIZAÇÃO de computador. O utilizador compra uma licença ONE
para usar o VBdocman num computador ONE.
2. Uma licença DE UTILIZAÇÃO DO SITE. O utilizador compra uma única licença DE UTILIZAÇÃO,
autorizando a utilização da VBdocman, pelo comprador, os compradores
funcionários ou agentes credenciados, num número ilimitado de computadores
no mesmo local físico do SITE. Esta localização do SITE
normalmente ser definido como um único edifício, mas poderia ser considerado
ser um número de edifícios dentro do mesmo, geral, geográfico
localização, como uma propriedade industrial ou cidade pequena.
Uma vez registado, o utilizador recebe uma licença não exclusiva para usar
VBdocman em tantos computadores definidos pelos termos de licenciamento acima
de acordo com o número de licenças adquiridas, para qualquer finalidade legal.
Não pode utilizar, copiar, imitar, clonar, alugar, arrendar, vender, modificar,
decompil, desmontar, de outra forma engenheiro inverso, ou transferir o
programa licenciado, ou qualquer subconjunto do programa licenciado, exceto como
previsto neste acordo. Qualquer tal utilização não autorizada deve
resultar em rescisão imediata e automática desta licença e pode
resultam em processos criminais e/ou civis.
A versão do julgamento VBdocman, pode ser distribuída livremente,
desde que a embalagem de distribuição não seja modificada. Nenhuma pessoa ou
empresa pode cobrar uma taxa pela distribuição de VBdocman sem escrito
autorização do autor.
Para se registar consulte o site da casa da VBdocman http://www.vbdocman.com
GARANTIA LIMITADA
O autor não garante que as funções contidas neste software
cumprirão os seus requisitos ou que o software será livre de erros.
EM NENHUM CASO SERÁ AUTOR SERÁ RESPONSÁVEL POR QUALQUER DANO, INCLUINDO QUALQUER
LUCROS PERDIDOS, POUPANÇAS PERDIDAS OU OUTROS DANOS ACIDENTAIS OU CONSEQUENTES
DECORRENTES DO USO OU INCAPACIDADE DE USAR ESTE PROGRAMA, OU PARA QUALQUER REIVINDICAÇÃO
POR QUALQUER OUTRA PARTE. TODO O RISCO QUANTO AOS RESULTADOS E DESEMPENHO DE
O PROGRAMA E DOCUMENTAÇÃO SÃO ASSUMIDOS POR SI.
O autor mantém o título à propriedade do software. Todas as cópias e
porções do software, de qualquer forma, pertencem ao autor que retém
todos os direitos não expressamente concedidos.
Instalar e utilizar o VBdocman significa aceitação destes termos e
condições da licença.
Se não concorda com os termos desta licença, deve remover vBdocman
ficheiros dos seus dispositivos de armazenamento e deixam de utilizar o produto.
