VBdocman é um programa para geração automática de documentação técnica a partir de seus arquivos de origem Visual Basic com apenas alguns cliques do mouse. Ele analisa o código-fonte e cria automaticamente 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 usuário. Os formatos de saída predefinidos são:
Ajuda HTML (arquivo*.chm que se parece com MSDN)-
Arquivos HTML (com índice Java e tabela de conteúdo)
WinHelp (arquivo*.hlp)
Documento RTF
Xml
VBdocman funciona como um complemento no MS Visual Basic 6.0. Depois de invocar diálogo simples através do menu principal e (no caso mais simples) clicar em um botão, a documentação de saída especificada é gerada. Ele cria automaticamente todos os links interessantes, como Applies To, Methods, Events, Properties, Events, table of contents e index. Em projetos maiores só esse trabalho economiza muitos dias de trabalho chato. A documentação pode ser então editada e descrição adicional dada lá, como Ver Também, exemplos de links, objeto, método, descrição de propriedade ou evento, descrição dos parâmetros e assim por diante. O VBdocman permite adicionar até 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 usuário não é forçado a escrever comentários manualmente, VBdocman adiciona-o por dois cliques do mouse. Todas as tags necessárias são adicionadas e o usuário preenche apenas uma descrição curta para elas. Além disso, fornece um editor de comentários sofisticado e amigável.
Vantagens:
Consistência. Se algo foi adicionado ao código, por exemplo, novo método, ele é automaticamente refletido na documentação recém-gerada.
A documentação em vários formatos pode ser gerada por poucos cliques do mouse. Então você tem documentação em todos os formatos suportados em poucos minutos.
Comunicação eficiente dentro da equipe, especialmente quando o Source Safe é usado. Todo programador comenta sua parte do código.
história da versão
- Versão 2.25 postado em 2005-11-09
Saída aprimorada e correções de bugs.
Detalhes do programa
Eula
EULA - Contrato de Licença do Usuário Final
CONTRATO DE LICENÇA DA VBDOCMAN
O complemento VBdocman NÃO é freeware. Isso significa:
Todos os direitos autorais da VBdocman são de propriedade exclusiva do autor - Peter Macej (HELIXOFT).
Qualquer pessoa pode usar este software durante um período de teste de 14 dias.
Após este período de teste de 14 dias ou menos, se você quiser continuar
para usar vbdocman, você DEVE registrar (comprar). Quando você compra VBdocman, você se torna
usuário registrado.
Existem seguintes tipos de licenças emitidas para VBdocman:
1. Uma única licença de USO do computador. O usuário compra uma licença
para usar o VBdocman em um computador.
2. Uma licença de USO DO SITE. O usuário compra uma única licença DE USO,
autorizando o uso do VBdocman, pelo comprador, os compradores
funcionários ou agentes credenciados, em um número ilimitado de computadores
no mesmo local físico do SITE. Esta localização SITE seria
normalmente ser definido como um único edifício, mas poderia ser considerado
para ser um número de edifícios dentro do mesmo, geral, geográfico
localização, como uma propriedade industrial ou cidade pequena.
Uma vez registrado, o usuário recebe uma licença não exclusiva para usar
VBdocman em tantos computadores como definido pelos termos de licenciamento acima
de acordo com o número de licenças adquiridas, para qualquer finalidade legal.
Você não pode usar, copiar, imitar, clonar, alugar, alugar, vender, modificar,
descompilar, desmontar, de outra forma engenheiro reverso, ou transferir o
programa licenciado, ou qualquer subconjunto do programa licenciado, exceto como
previsto neste acordo. Qualquer uso não autorizado deve
resultam em rescisão imediata e automática desta licença e podem
resultando em processo criminal e/ou civil.
A versão de teste VBdocman, pode ser distribuída livremente,
desde que o pacote de distribuição não seja modificado. Nenhuma pessoa ou
empresa pode cobrar uma taxa para a distribuição de VBdocman sem escrito
permissão do autor.
Para se cadastrar, consulte o site da VBdocman http://www.vbdocman.com
GARANTIA LIMITADA
Autor não garante que as funções contidas neste software
atenderá aos seus requisitos ou que o software será livre de erros.
EM NENHUM CASO SERÁ AUTOR DE QUAISQUER DANOS, INCLUINDO QUALQUER
LUCROS PERDIDOS, POUPANÇAS PERDIDAS OU OUTROS DANOS INCIDENTAIS OU CONSEQUENTES
DECORRENTE DO USO OU INCAPACIDADE DE USAR ESTE PROGRAMA, OU PARA QUALQUER RECLAMAÇÃO
POR QUALQUER OUTRA PARTE. TODO O RISCO QUANTO AOS RESULTADOS E DESEMPENHO DE
O PROGRAMA E A DOCUMENTAÇÃO SÃO ASSUMIDAS POR VOCÊ.
Autor mantém título para a propriedade do software. Todas as cópias e
partes do software, de qualquer forma, pertencem ao autor que retém
todos os direitos não concedidos expressamente.
Instalar e usar vbdocman significa aceitação desses termos e
condições da licença.
Se você não concorda com os termos desta licença, você deve remover VBdocman
arquivos de seus dispositivos de armazenamento e deixar de usar o produto.
