Quel logiciel ou quel add-on utilisez-vous pour documenter votre code Delphi ?

Quels sont vos conseils et vos maîtres-choix ?

Le 2013-07-03 12:07:37, par pepito62, Membre habitué

Documenter son code Delphi
Quel logiciel ou add-on utilisez-vous ?

Bonjour,

Existe t-il un logiciel ou un "add-on" Delphi pour documenter son code ?

J'ai trouvé "delphicodetodoc", très bien à première vue, à la mode JavaDoc.
Mais je m'aperçois qu'il ne gère pas les groupes de projet (*.dpg ou *.groupproj).
Très embêtant car le projet Delphi gère les packages (bpl) avec plus de 2000 fichiers .pas.

J'ai vu dans la version Delphi XE4 qu'il y a Documentation Insight de chez devjetsoftware mais que la génération finale fait "usine".

Qu'utilisez-vous ?

Savez-vous si on peut personnaliser la génération (type d'information ou section visible ou non...) avec la version payante de Documentation Insight ?

Discussion forum

5 commentaires

ShaiLeTroll
Expert éminent sénior

Pour ma part, j'ai utilisé delphicodetodoc !

Actuellement sur BCB, j'utilise les cartouches de documentation mais pas l'outil, mon responsable ne fait pas de commentaire

Il est déjà pas mal d'avoir une documentation dans les sources, il faut penser à générer les HMTL après une modification, il est vrai que c'est plus facile de naviguer dans ce format que via une recherche dans Delphi

Je te confirme, qu'il y a bcp de doublons lorsque les projets utilisent des unités communes, et parfois des trous si ils ne trouvent pas les dépendances

Après, je faisais des documentations Word pour les ActiveX que j'externalisais en suivant un modèle, une documentation de la TLB et une version utilisateur (avancé \ lambda)

le 03/07/2013 à 12:17
ShaiLeTroll
Expert éminent sénior

Envoyé par pepito62

Vous me confirmez, il n'est pas possible de gérer des groupes de projet avec delphicodetodoc ?

Je n'ai jamais suffisamment approfondi pour le dire !
Lors de son utilisation, j'avais des projets séparés (de très gros EXE) et la quantité de documentation ne couvrait que mes modules (à peine 10% du code), le reste développé par plusieurs développeurs n'avait pas vraiment de norme à ce sujet

Il me semble qu'un collègue de l'époque, avait intégré cela au FinalBuilder de ses projets.

Envoyé par pepito62

Envoyé par ShaiLeTroll

Je te confirme, qu'il y a bcp de doublons lorsque les projets utilisent des unités communes, et parfois des trous si ils ne trouvent pas les dépendances

Généralement les générateurs parcourent les fichiers sources (*.pas) et décrivent les objets/méthodes...

En fait, actuellement, je suis conforme avec la syntaxe Doxygen (BCB), il fonctionne à partir d'un répertoire et non à partir d'un projet C++Builder !
Ce qui est tout à fait logique puisque Doxygen est général au C++, il ne peut pas se spécialiser pour tel ou tel environnement !

DelphiToDoc fonctionne de la même façon et sait analyser un DPR mais pas les DPROJ si j'ai bien compris, n'ayant pas dépasse D7 avec DTD, je n'en sais pas plus

Mais si l'on part du répertoire racine, on se retrouve avec un monstre sur plusieurs projets qui durent une plombe à générer, donc il est préférable de découper

Si tu veux séparer, il faut partir sur le dossier regroupant les sources d'un projet, selon les outils, tu peux mettre des références sur des documentations externes (utile si tu as une lib commune)

Sauf que si tu as un programme écrit avec la version N de la lib et un autre en N+1, si tu changes la documentation externe de la lib en N+1, tes références de la version N ne seront peut-être plus conforme... encore un soucis

Idem, si tu as un projet qui utilise des unités d'un autre, je pense par exemple à une DLL ou le fichier des déclarations de types est commun à la DLL et aux modules appelant
Cela peut devenir fort compliquer de gérer les dépendances

Ensuite tout dépend comment tes sources sont organisées, actuellement, mon responsable a choisi de mettre tous les fichier cbproj dans le même répertoire, puis il y a tout un découpage en sous-dossier, les projets utilisant les unités d'autres projets, ... un peu confus tout ça à mon gout !

le 03/07/2013 à 13:41
ShaiLeTroll
Expert éminent sénior

C'est vrai que cela semble fort sympa avec l'éditeur intégré !
Dommage, cela n'existe pas en C++Builder !

le 03/07/2013 à 15:33
pepito62
Membre habitué

Vous me confirmez, il n'est pas possible de gérer des groupes de projet avec delphicodetodoc ?

Dans mon cas, la génération de la documentation se fera automatiquement à chaque versions majeures et à chaque "ServicePack" (Lot de correctif).

Mais elle pourra être lancé manuellement à un instant T si on souhaite avoir la dernière documentation.

Je te confirme, qu'il y a bcp de doublons lorsque les projets utilisent des unités communes

???
Généralement les générateurs parcourent les fichiers sources (*.pas) et décrivent les objets/méthodes...

le 03/07/2013 à 12:46
pepito62
Membre habitué

Je viens de télécharger la version Pro de Documentation Insight (limité à 15 jours) et la génération n'a rien à voir.

C'est beaucoup plus lisible. De plus il existe différents formats de sortie.

Je vous conseille de visualiser les vidéos youtube et de l'essayer.

Du coup, j'ai trouvé mon bonheur. En espérant ne pas être embéter avec un gros projet.

Merci.

le 03/07/2013 à 14:42