VBdocman est un programme de génération automatique de documentation technique à partir de vos fichiers source Visual Basic en quelques clics de souris. Il parses code source et crée automatiquement tableau des contenus, index, sujets, références croisées et l’aide context sensitive. Le format de la documentation de sortie est entièrement configurable par l’utilisateur. Les formats de sortie prédéfinis sont les :
Aide HTML (fichier*.chm qui ressemble à MSDN)-
Fichiers HTML (avec index Java et tableau de contenu)
WinHelp (fichier*.hlp)
Document RTF
Xml
VBdocman fonctionne comme un add-in dans MS Visual Basic 6.0. Après avoir invoquant un dialogue simple à travers le menu principal et (dans le cas le plus simple) en cliquant sur un bouton, la documentation de sortie spécifiée est générée. Il crée automatiquement tous les liens intéressants tels que s’applique à, méthodes, événements, propriétés, événements, tableau des contenus et index. Dans les grands projets seulement ce travail permet d’économiser de nombreux jours de travail ennuyeux. La documentation peut ensuite être modifiée et une description supplémentaire y est donnée, comme voir aussi, exemples de liens, objet, méthode, description de propriété ou d’événement, description des paramètres et ainsi de suite. VBdocman permet d’ajouter même cette description automatiquement en l’extrayant du commentaire de code source à partir de balises spéciales. Il fonctionne de la même manière que le système JavaDoc. Mais, utilisateur n’est pas obligé d’écrire des commentaires manuellement, VBdocman l’ajoute lui-même juste par deux clics de souris. Toutes les balises nécessaires sont ajoutées et l’utilisateur remplit ensuite une courte description pour eux. En outre, il fournit un éditeur de commentaires convivial sophistiqué.
Avantages:
Cohérence. Si quelque chose a été ajouté au code, par exemple une nouvelle méthode, il est automatiquement reflété dans la documentation nouvellement générée.
La documentation dans différents formats peut être générée par quelques clics de souris. Ainsi, vous avez de la documentation dans tous les formats pris en charge en quelques minutes.
Communication efficace au sein de l’équipe, en particulier lorsque Source Safe est utilisé. Chaque programmeur commente sa part de code.
historique de la version
- Version 2.25 posté sur 2005-11-09
Corrections améliorées de sortie et de bogues.
Détails du programme
Cluf
EULA - Accord de licence utilisateur final
CONTRAT DE LICENCE VBDOCMAN
Le VBdocman Add-In n’est pas freeware. Cela signifie :
Tous les droits d’auteur de VBdocman sont exclusivement la propriété de l’auteur - Peter Macej (HELIXOFT).
N’importe qui peut utiliser ce logiciel pendant une période d’essai de 14 jours.
Après cette période d’essai de 14 jours ou moins, si vous souhaitez
pour utiliser VBdocman, vous devez vous inscrire (acheter). Lorsque vous achetez VBdocman, vous devenez
utilisateur enregistré.
Il existe des types suivants de licences délivrées pour VBdocman :
1. Une licence d’utilisation d’ordinateur unique. L’utilisateur achète une licence
d’utiliser le VBdocman sur un seul ordinateur.
2. Une licence d’UTILISATION DE SITE. L’utilisateur achète une seule licence UTILISATION,
l’utilisation de VBdocman, par l’acheteur, les acheteurs
employés ou agents accrédités, sur un nombre illimité d’ordinateurs
au même emplacement physique. Cet emplacement site serait
normalement défini comme un seul bâtiment, mais pourrait être considéré comme
d’être un certain nombre de bâtiments dans le même, général, géographique
comme une zone industrielle ou une petite ville.
Une fois enregistré, l’utilisateur obtient une licence non exclusive d’utilisation
VBdocman sur autant d’ordinateurs que défini par les termes de licence ci-dessus
en fonction du nombre de licences achetées, à des fins légales.
Vous ne pouvez pas utiliser, copier, imiter, cloner, louer, louer, vendre, modifier,
décompile, démonter, autrement reverse engineer, ou transférer le
programme autorisé, ou tout sous-ensemble du programme autorisé, sauf en tant que
prévues dans cet accord. Toute utilisation non autorisée de ce genre
entraîner la résiliation immédiate et automatique de cette licence et peut
entraîner des poursuites pénales et/ou civiles.
La version d’essai VBdocman, peut être librement distribuée,
à condition que le paquet de distribution ne soit pas modifié. Aucune personne ou
société peut facturer des frais pour la distribution de VBdocman sans
l’autorisation de l’auteur.
Pour vous inscrire, consultez le site d’accueil de VBdocman http://www.vbdocman.com
GARANTIE LIMITÉE
L’auteur ne justifie pas que les fonctions contenues dans ce logiciel
répondront à vos exigences ou que le logiciel sera exempt d’erreurs.
EN AUCUN CAS L’AUTEUR NE VOUS SERA TENU RESPONSABLE DE TOUT DOMMAGE, Y COMPRIS
PERTE DE PROFITS, PERTE D’ÉPARGNE OU AUTRES DOMMAGES ACCESSOIRES OU CONSÉQUENTS
DÉCOULANT DE L’UTILISATION OU DE L’INCAPACITÉ D’UTILISER CE PROGRAMME, OU DE TOUTE RÉCLAMATION
PAR N’IMPORTE QUELLE AUTRE PARTIE. L’ENSEMBLE DU RISQUE QUANT AUX RÉSULTATS ET AUX PERFORMANCES DES
LE PROGRAMME ET LA DOCUMENTATION SONT ASSUMÉS PAR VOUS.
L’auteur conserve le titre à la propriété du logiciel. Toutes les copies et
parties du logiciel, sous quelque forme que ce soit, appartiennent à l’auteur qui conserve
tous les droits qui ne sont pas expressément accordés.
L’installation et l’utilisation de VBdocman signifient l’acceptation de ces termes et
conditions de la licence.
Si vous n’êtes pas d’accord avec les termes de cette licence, vous devez supprimer VBdocman
fichiers de vos périphériques de stockage et cesser d’utiliser le produit.
