VBdocman es un programa para la generación automática de documentación técnica a partir de sus archivos de origen de Visual Basic con unos pocos clics del ratón. Analiza el código fuente y crea automáticamente tabla de contenido, índice, temas, referencias cruzadas y ayuda contextual. El formato de la documentación de salida es totalmente configurable por el usuario. Los formatos de salida predefinidos son:
Ayuda HTML (archivo *.chm que se parece a MSDN)-
Archivos HTML (con índice Java y tabla de contenido)
WinHelp (archivo *.hlp)
Documento RTF
Xml
VBdocman funciona como un complemento en MS Visual Basic 6.0. Después de invocar un cuadro de diálogo simple a través del menú principal y (en el caso más simple) haciendo clic en un botón se genera la documentación de salida especificada. Crea automáticamente todos los vínculos interesantes como Se aplica a, métodos, eventos, propiedades, eventos, tabla de contenido e índice. En proyectos más grandes sólo este trabajo ahorra muchos días de trabajo aburrido. A continuación, se puede editar la documentación y la descripción adicional dada allí, como Ver también, Ejemplos enlaces, objeto, método, descripción de propiedad o evento, descripción de parámetros, etc. VBdocman permite añadir incluso esa descripción automáticamente extrayéndola del comentario del código fuente de etiquetas especiales. Funciona de forma similar a javadoc sistema. Pero, el usuario no está obligado a escribir comentarios manualmente, VBdocman lo añade a sí mismo sólo con dos clics del ratón. Se agregan todas las etiquetas necesarias y el usuario rellena una breve descripción para ellas. Además, proporciona un sofisticado editor de comentarios fácil de usar.
Ventajas:
Consistencia. Si se ha añadido algo al código, por ejemplo, un nuevo método, se refleja automáticamente en la documentación recién generada.
La documentación en varios formatos se puede generar con unos pocos clics del ratón. Así que tiene documentación en todos los formatos compatibles en pocos minutos.
Comunicación eficiente dentro del equipo, especialmente cuando se utiliza Source Safe. Cada programador comenta su parte del código.
historial de versiones
- Versión 2.25 publicado en 2005-11-09
Salida mejorada y correcciones de errores.
Detalles del programa
Cluf
EULA - Contrato de licencia de usuario final
CONTRATO DE LICENCIA DE VBDOCMAN
El complemento VBdocman NO es freeware. Esto significa:
Todos los derechos de autor de VBdocman son propiedad exclusiva del autor Peter Macej (HELIXOFT).
Cualquier persona puede utilizar este software durante un período de prueba de 14 días.
Después de este período de prueba de 14 días o menos, si desea continuar
para utilizar VBdocman, DEBE registrarse (comprar). Cuando usted compra VBdocman, se convierte en
usuario registrado.
Existen los siguientes tipos de licencias emitidas para VBdocman:
1. Una sola licencia de uso de la computadora. El usuario compra UNA licencia
para UTILIZAR el VBdocman en UN ordenador.
2. Una licencia de uso del sitio. El usuario compra una sola licencia DE USO,
autorizando el USO de VBdocman, por el comprador, los compradores
empleados o agentes acreditados, en un número ilimitado de computadoras
en la misma ubicación física del SITIO. Esta ubicación del SITIO
normalmente se definen como un solo edificio, pero podría considerarse
ser una serie de edificios dentro de la misma, general, geográfica
como un polígono industrial o una pequeña ciudad.
Una vez registrado, se concede al usuario una licencia no exclusiva para
VBdocman en tantos ordenadores como se definen en los términos de licencia anteriores
de acuerdo con el número de licencias adquiridas, para cualquier propósito legal.
Usted no puede usar, copiar, emular, clonar, alquilar, arrendar, vender, modificar,
descompilación, desensamblar, de otro modo realizar ingeniería inversa, o transferir la
programa con licencia, o cualquier subconjunto del programa con licencia, excepto como
prevista en este acuerdo. Cualquier uso no autorizado deberá
la terminación inmediata y automática de esta licencia y puede
enjuiciamiento penal y/o civil.
La versión de prueba de VBdocman, puede ser distribuida libremente,
siempre que el paquete de distribución no se modifique. Ninguna persona o
empresa puede cobrar una tarifa por la distribución de VBdocman sin
permiso del autor.
Para registrarse, consulte el sitio de inicio de VBdocman http://www.vbdocman.com
GARANTÍA LIMITADA
Autor no garantiza que las funciones contenidas en este software
cumplirá con sus requisitos o que el software estará libre de errores.
EN NINGUNA CASO EL AUTOR SE RESPONSABILIZA A USTED POR NINGUNA Daño, INCLUYENDO CUALQUIER
PERDIDAS, AHORROS PERDIDOS U OTROS DAños INCIDENTALES O CONSECUENTES
QUE SURJA DEL USO O LA INCAPACIDAD DE USAR ESTE PROGRAMA, O PARA CUALQUIER RECLAMO
POR CUALQUIER OTRA PARTE. TODO EL RIESGO EN CUANTO A LOS RESULTADOS Y EL RENDIMIENTO DE
EL PROGRAMA Y LA DOCUMENTACIÓN SON ASUMIDOS POR USTED.
El autor conserva el título de la propiedad del software. Todas las copias y
partes del software, en cualquier forma, pertenecen al autor que conserva
todos los derechos no concedidos expresamente.
Instalar y usar VBdocman significa la aceptación de estos términos y
condiciones de la licencia.
Si no está de acuerdo con los términos de esta licencia, debe eliminar VBdocman
archivos de sus dispositivos de almacenamiento y deje de utilizar el producto.
