VBdocman 2.25

Sobre VBdocman

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.