DelphiDoc

Présentation

DelphiDoc est un utilitaire de génération automatique de documentation de codes sources Pascal Objet au format HTML, dont je suis l'auteur, se présentant sous forme d'expert pour Delphi 5.
Au travers de commentaires spéciaux, DelphiDoc incorpore dans la documentation générée les descriptions correspondants à l'unité, ses constantes, variables, classes, procédures et fonctions.
On se reportera à l'unité Unit1, reprise dans le fichier Unit1.html ci-dessous, pour ce qui concerne la manière d'utiliser les commentaires spéciaux "(**" et "*)" employés par DelphiDoc :

Unit1.html

L'utilisation de DelphiDoc requiert l'installation d'Internet Explorer (au minimum la version 5 est recommandée) venant avec celle du parser XML de Microsoft. Vous pouvez le vérifier en constatant la présence du fichier MSXML.DLL dans votre répertoire système.

DelphiDoc s'intègre dans l'IDE de Delphi :

Génération de la documentation

Après son installation, l'expert DelphiDoc est accessible depuis le menu "Voir/DelphiDoc" de Delphi ; celui-ci affiche dans une vue arborescente l'ensemble des unités et fiches du projet courant.
Il est alors possible de produire la documentation pour le projet entier, en sélectionnant d'abord le noud racine, ou celle d'une unité particulière que vous sélectionnez, en actionnant le bouton "Generate doc". Vous pouvez aussi appeler un menu contextuel avec le bouton droite de la souris pour demander la génération de la documentation de l'unité sélectionnée.
Le bouton "View doc", quand à lui, déclenchera l'exécution d'Internet Exporer (ou bien celle de l'exécutable rattaché à l'extension html) ; si c'est le noud racine qui est sélectionné et que la génération s'est bien déroulée, IE ouvrira le fichier index.html, ou bien le fichier html sommaire de l'unité sélectionnée (voir plus bas).
La génération des fichiers HTML ne fonctionnera que sur des unités syntaxiquement correctes, ce qui est assuré par une compilation sans erreur.

Fichiers générés

Voici les fichiers produits, leurs emplacment et leurs descriptions lors de la génération automatique de documentation du projet C:\fichiers\project1.dpr comprenant l'unité Unit1.pas (le . représente le répertoire courant du projet) :

.\Doc\index.html

index.html reprend l'ensemble des unités du projet avec leurs descriptions respectives, ainsi que des liens hypertextes vers celles-ci.

.\Doc\Unit1\Unit1-sommaire.html

Ce fichier constitue le sommaire de l'unité Unit1, ce qui comprend les descriptions éventuelles des éléments de l'unité, les constantes et les variables des parties interface et implélentation, les classes, ainsi que les procédures et fonctions globales.

.\Doc\Unit1\Unit1-TMaClasse.html

Ce fichier décrit la classe TMaClasse déclarée dans Unit1 et toutes ses données membres.

.\Doc\Unit1\Unit1-foncprocs.html

Les procédures et fonctions globales de l'unité Unit1 sont décrites ici.

.\Doc\Unit1\Unit1-index.html

L'index de l'unité Unit1 liste tous les éléments accessibles de l'unité.

Appliqué au projet Delphi 5 project1.dpr comportant l'unité Unit1, DelphiDoc produit les fichiers HTML suivants :

index.html
Unit1-sommaire.html
Unit1-TMaClasse1.html
Unit1-TMaClasse2.html
Unit1-foncprocs.html
Unit1-index.html

Téléchargement de DelphiDoc 1.0.0.7

La version shareware de DelphiDoc 1.0, que vous pouvez télécharger ci-après, générera les fichiers indiqués ci-dessus, mise à part le fichier index.html, dans le répertoire temporaire utilisé par Windows.

delphidc.zip
DelphiDoc sera alors disponible au prochain démarrage de Delphi.

La version complète de DelphiDoc peut être commandée auprès du site ShareIt!
Acquérir la version complète encourage la réalisation d'applications utiles et intéressantes ; d'autre part vous bénéficierez des évolutions futures de DelphiDoc, comme les mises à jour pour les versions suivantes de Delphi, la possibilité de créer vos propres modèles de documentation, etc.

Notes techniques

DelphiDoc utilise le parser XML de IE implementé dans MSXML.DLL aussi bien pour la génération de documents XML issus de l'analyse des unités que pour la création des fichiers HTML à l'aide de feuilles de style XSL.
Ces feuilles de style XSL sont incluses dans le fichier ExprtDelphiDoc.dll dans des composants TRCData dont il est aussi question sur ce site.

Sommaire

Présentation
Génération de la documentation
Fichiers générés
Téléchargement de DelphiDoc 1.0.0.7
Notes techniques

Début