Discussion :

[Laurent Dardenne]

laurent, la prochaine version v0.10b sort demain (11 novembre).

Bonne nouvelle !!!

Il y a eu bcq de retard

Il faut du temps pour que les choses se bonifient

et un grand merci pour l'ajout du @Comment TAG


Je regarde ça ce WE et te fais un retour.

[trident_job]

DelphiCodeToDoc v0.10Beta disponible - Outil gratuit de generation de documentation pour Delphi

La dernière version de DelphiCodeToDoc (v0.10Beta) est disponible. Elle peut être téléchargée ici :

http://prdownloads.sourceforge.net/d...b.zip?download

DelphiCodeToDoc est un outils gratuit de génération de documentation pour Delphi, distribuer sous la licence GNU - GPL. Il utilise les informations contenu dans le code source, comme les symboles et les commentaires formattés, pour produire une documentation précise de votre code ou de votre composant.

Situation : DelphiCodeToDoc continue en version en Beta. Il sortira en Stable (v1.0) dans une des prochaines versions (il faut d'abord corriger tous les bugs majeurs).

-----------------------------------------------------------------
Quelles sont les nouveautés de cette version ?
Cette version v0.10Beta contient les modifications suivantes :

Ajout du support du TAG "Todo"
Ajout de l'option "Filtrage des membres en sortie" pour afficher/masquer certaines catégories (Tracker 997979)
Correction de l'Exception "Directories not exists"
Correction du menu et de la barre d'outils toujours actifs lors de l'analyse et de la construction (Tracker 1035514)
Correction de l'option "Avertir lors d'un TAG vide" (Tracker 1035953)
Amélioration de la prise en charge des TAGs vides
Ajout du support des commentaires étendus avec le TAG @Comment
Ajout du support des commentaires étendus dans les méthodes (avec DoubleSlash)
Amélioration de la reconnaissance des TAGs multi-lignes
Mise à jour des traductions
Ajout des traductions en Russe (Tracker 1036934)
Changement du curseur en 'occupé' lors de la construction de la documentation (Tracker 1035514)
Ajout d'un menu "Voir documentation" (Tracker 1035514)
Ajout d'un seul menu "Vérifier et construire" (Tracker 1035514)
Ajout d'un menu "Purger répertoire de sortie" (Tracker 1035514)
Amélioration du HTML créé (Tracker 1035636)
Correction des commentaires de fin de ligne non reconnus pour les méthodes (Tracker 1038663)
Ajout du support des interfaces (Tracker 1012884)
Ajout du support des ancetres multiples (classes et interfaces)
Correction de l'exception avec le "type procedural" for les membres (Tracker 1042560)
Correction de la police de caractères du menu qui n'accepte pas le Russe (Tracker 1036772)


Quels sont les bugs connus du logiciel ?
*Aucune pour le moment

Quelles sont les limitations connues du programme ?
*Les méthodes avec le même nom (surchargées) dans une classe resulterons en une seule fonction dans le rapport de sortie
*Les fonctions avec le même nom (surchargées) resulterons en une seule fonction dans le rapport de sortie
*Aucun "define" du pre-processeur ne peuvent être définis
*Les propriétés n'ont pas de description (mais sont générées)
*Les évenements n'ont pas de description
*Seul le format HTML sera généré pour la documentation
*Seul l'Anglais est disponible pour le document généré
*Le TAG @see n'est pas supporté

Quelles seront les futures évolutions ?
*Ajouter le choix de la langue pour la génération de la documentation
*Ajout d'un nouvel expert "création du projet" complet et plus estétique
*Support du CHM en sortie

[Séb@stieN]

Je vient de tester DElphiCodeToDoc.
Voici quelques petites remarques:
* Est 'il possible de rendre les propriéte ReadOnly en lecture ecriture ( surtout le chemin le sorti)
* Mettre quelque racourci clavier du type F9 pour Check and build

Pourrais t'il possible d'exclure certain Fichier????

Voila durant mes 5 min de test les remarque qui me vienne tout de suite.

[trident_job]

Salut !

* Est 'il possible de rendre les propriéte ReadOnly en lecture ecriture ( surtout le chemin le sorti)

Non, pour l'instant, les propriétés ReadOnly le sont pour être figée Par exemple, le chemin est choisi au départ une fois pour toute pour ce projet. Il faudra attendre la version v1.0 pour voir disparaitre ces limitations.

* Mettre quelque racourci clavier du type F9 pour Check and build

Oui, bonne idée ! L'Interface utilisateur, c'est pas mon fort.
Je viens d'ouvrir un Tracker pour ce point : http://sourceforge.net/tracker/index...81&atid=614258

* Pourrais t'il possible d'exclure certain Fichier????

Non, pas pour l'instant, DCTD scan l'intégralité du répertoire. Il faudra attendre la v1.0 pour cela.

[Séb@stieN]

Sinon autre petite remarque je l'ai tester un projet d'environs 80 fiche et le programme bloque ( devient Pas de réponse dans le gestionnaire de tache il doit manquer quelque apllication.processmessage

Sinon pour pas mal de projet j'utilise un gestionnaire de mémoire alternatif RecyclerMM et je pense que ppour ton application il l'accéléra pas mal c a tester....

[trident_job]

Le fait que le programme se bloque n'est evidemment pas normal, bizarre. Je l'ai pourtant testé sur de gros volume de fichiers, sans problème jusqu'à présent.

Côté rapidité, globalement, le projet n'est pas optimisé pour la vitesse, il y a encore bcq d'infos de debug, d'assertions, de vérification d'indices de tableaux etc ... dans le code. Dans la dernière beta, cela ne sera pas compilé, donc plus rapide.

Et la rapidité est très relative au PC utilisé : Je developpe sur un P2-500Mhz, donc oui, lorsque je lance l'analyse de 100 fichiers, c'est lent.
Mais mes tests sont réalisés principalement sur un P4HT-2,8Ghz, et les 100 fichiers sont avalés en qcq secondes

Pour aller un peu plus vite, essaie de passer par DCTD_cmd.exe qui fonctionne en ligne de commande, c'est un peu plus rapide chez moi.

Je regarderai RecyclerMM pour voir.
Merci pour tes remarques !

TridenT

[Séb@stieN]

C'est un bon soft il a bug lol
* le tag @return n'est pas pris en compte lors de la génération de la documentation il met le message "#No TAG found in source code#"
* Dans les menu "Check Project" et "Build PRojet" ne sont jamais actif.


Sinon :
* j'ai essayer de compiller tes sources mais ca compile pas (j'ai la dernière version de la JCL)

* oui le check est rapide mes la génération est assez longue. ( ma machine est pourtant un peu puissante (2x 1,8Gz)

* sinon serais t' il possible de faire des sous repertoire par unité car actuellemnt je trouve que ca génère baucoup de fichier dans un meme repertoire ...

[trident_job]

* le tag @return n'est pas pris en compte lors de la génération de la documentation il met le message "#No TAG found in source code#"

Zut ! J'ai pas fini d'écrire tous les tests avec DUnit, et celui-ci en particulier ! Le bug est reproduit, je corrige ça rapidos.

* Dans les menu "Check Project" et "Build PRojet" ne sont jamais actif.

Ces menus ne drvaient plus apparaitre, ils sont remplacé par "Check and Build".

* j'ai essayer de compiller tes sources mais ca compile pas (j'ai la dernière version de la JCL)

Extrait du fichier DelphiCodeToDoc.txt:
Library used in project
*DelphiCodeToDoc need the stable release of JCL&JVCL to compile: Package JCL&JVCL v2.10. It includes :
*Jedi Code Library, Release 1.22, Build 965 22-Oct-2002
*JEDI VCL 2.10 for D5-D7
*To fix a bug with very high speed computer, Replace JclSysInfo.pas with the new one (available on download page), and rebuild JCL.


Concernant les sous répertoires, je vais y réflechir oui.

Merci pour tes remarques.
TridenT

[trident_job]

Sur la page web de DCTD, toutes les infos pour recompiler:
http://dephicodetodoc.sourceforge.ne...developers.htm

[Xander]

Bonjour

je me suis fais un petit projet delphi qui me permet de selectionner le chemin vers le projet DCD, puis le chemin vers le projet HHC (html help worker) et qui lance au final un point bat en passant en parametre les chemin.
Le tout sert bien sur à générer un fichier CHM sans ouvrir les IHM.

Le problème c'est qu'on est forcé de lancer l'IHM au moins une fois pour créer le projet.

Est ce qu'il y aurait un moyen de créer un projet par ligne de commande en lui passant un dossier de destination pour les fichier de sortie. :

Serait il possible aussi de vider ce dossier par ligne de commande. :

Merci encore pour ce logiciel très pratique.

Xander

[trident_job]

Xander, si tu attends la prochaine version, le CHM sera supporté d'office, avec création des TOC et Index en prime !

Aujourd'hui, oui, il faut lancer au moins une fois l'IHM pour créer le fichier projet. Le format du fichier *.DCD sera migré vers XML dans la version stable v1.0, et donc, éditable si tu y tiens !
Tracker ici -> http://sourceforge.net/tracker/index...81&atid=614258

Le projet en ligne de commande permet uniquement de vérifeir et de genérer la documentation, pas plus pour l'instant. Je prends note, dans les versions futures, j'ajouterai des options en ligne de commande pour vider le répertoire de sortie, ou toute autre commande disponible par le client IHM.
J'ai entré un tracker ici -> http://sourceforge.net/tracker/index...81&atid=614258

Merci de tes remarques.

TridenT

[bidulechouet]

Salut,

Sinon autre petite remarque je l'ai tester un projet d'environs 80 fiche et le programme bloque ( devient Pas de réponse dans le gestionnaire de tache il doit manquer quelque apllication.processmessage ....

Concernant l'assertion de Séb@stieN sur le manque de quelques 'apllication.processmessage;', nous pouvons te le confirmer, seb vient de modifier tes sources et maintenant la fenêtre de l'appli se redessine même pendant le processus de génération... Il va te faire remonter les modifs dès que nous aurons tout testé...

Par contre j'aurais quelques remarques concernant les fonctionnalités du soft... Notamment il serait intéressant de pouvoir suivre la progression du processus de génération de doc avec une 'progress bar' dans la 'status bar' par exemple... Dans le rapport de génération il serait également intéressant de connaître le temps de génération des doc...

D'ailleur, concernant le temps de génération, il pourrait être minimisé si le soft ne régénrait que les docs des fichiers modifiés à la façon d'un 'make' ou d'un 'Ant in anger'...

Une autre fonctionnalité qui pourrait être intéressante, serait de pouvoir paramétrer ou exclure certains types de commentaire... Je m'explique, par exemple, lorsque je modifie un fichier source, j'encadre les modification avec des commentaire ayant pour préfixe 1 '///'... je fais d'ailleur la même chose lorsque j'ajoute du code de déverminage (bug tracking)... ors actuellement ces commentaires sont inclus dans la doc, ce que je ne veux pas... bien évidemmant, lorsque le source est testé puis remonté dans le système de gestion de configuration, je les enleve...

bon j'arrête là pour aujourd'hui...

@++, bidulechouet

[Séb@stieN]

Pour le probleme de Blocage de l'application lors de la contruction en ajoutant un

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

Application.ProcessMessages;

a la ligne 213 du Fichier DocGen (nota il faut egalement ahouter dans les uses l'unité Forms

ainsi qu'a la ligne 193 du Fichier uDocProject

@+ et bon courrage

[trident_job]

Pour les Application.ProcessMessage, oky, j'ai rentré un tracker: http://sourceforge.net/tracker/index...81&atid=614255
Ce sera intégré dès que possible. C'est bizarre, car sur ma brouette de dev et le PC de test, j'ai pas ces problèmes.

Pour la progress bar, OK tracker: http://sourceforge.net/tracker/index...81&atid=614258
Pour le temps de la génération OK, tracker : http://sourceforge.net/tracker/index...81&atid=614258

>D'ailleur, concernant le temps de génération, il pourrait être minimisé si le soft ne régénrait que les docs des fichiers modifiés à la façon d'un 'make' ou d'un 'Ant in anger'...

Certe, mais pour l'instant, je preferre corriger tous les bugs du programme, finir les fonctionnalités les plus importantes et ensuite seulement m'attaquer à une quelconque optimisation. Est-ce si dramatique sur ton PC ?
Je garde en tête ton idée en tout cas, merci !

>Une autre fonctionnalité qui pourrait être intéressante, serait de pouvoir paramétrer ou exclure certains types de commentaire

Alors, sache que les commentaires JavaDoc que tu rentres dans ton code peuvent être préfixés comme tu veux. Dans les options du programme, tu peux configurer tes commentaires javaDoc en lignes (Inline Prefix //) avec un caractère de ton choix, rien n'impose que ce soit '/' pour faire ton inline en '///', même si c'est recommandé !
Mettre du code en commentaires ? Beurk !
Pourquoi n'écris-tu pas plutôt

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
//- CrashWindows(True);
ou encore 
//! CrashToutCourt;

Tu peux changer ta syntaxe ou jouer avec les options du programme pour que cela te convienne. Est-ce Clair pour toi ? Tiens moi au courant

Bon, j'espère avoir répondu à tes questions, je rentre tes demandes sous formes de Tracker, ainsi je suis sûr de pas les perdre, et tout le monde peut apporter des commentaires sur le sujet. Tu peux aussi suivre la progression du tracker et être informé par mail si tu as un compte SourceForge.
Merci à vous deux (bidulechouet et Séb@stieN), ca fait plaisir d'avoir des retours !
TridenT
PS: Ces parisiens, ils ont de l'imagination pour les pseudos !

[Séb@stieN]

Une methode relativement simple pour savoir si un fichier a été modifier est lors de la génération de la documentation tu enregistre dans un fichier la taille et le md5 de chaque fichier du project.
Puis lors de la regénération de la documentation dans la phase du parising tu verif si la taille et le md5 du fichier est identique ou pas s'il sont différent qtu regenère la doc du fichier.
Nota : je pense que juste le calcul du md5 devrais suffir.

C'est bizarre, car sur ma brouette de dev et le PC de test, j'ai pas ces problèmes.

Quand tu lance la génération de la documentation essais lors de la phase de build de bouger la fennêtre...

: Prefers tu les retours ici ou sur sourceforge???

[trident_job]

>Nota : je pense que juste le calcul du md5 devrais suffir.

je note, merci pour l'idée !

>Quand tu lance la génération de la documentation essais lors de la phase de build de bouger la fennêtre...

euh ... je suis pas anxieux à ce point là, lorsque qu'il génére la doc, je le laisse finir sans broncher, je travaille sur une autre appli mais je ne m'amuse pas à bouger la fenêtre dans tous les sens
De plus, si tu laisses cliquer sur la fenêtre, tu interromps le traitement de génération, vu que celui-ci n'est pas lancé dans un thread !
Bon, oky, je plaisante, j'ai compris

Prefers tu les retours ici ou sur sourceforge???

Dans SourceForge uniquement en Anglais (ca m'arrange!), sinon ici, je me charge de les recopier, à vous de voir !

je suis flatté que BideuleTrucMachinChose ait créer un compte juste pour poster un message dans ce topic

[bidulechouet]

Salut,

>Une autre fonctionnalité qui pourrait être intéressante, serait de pouvoir paramétrer ou exclure certains types de commentaire

Alors, sache que les commentaires JavaDoc que tu rentres dans ton code peuvent être préfixés comme tu veux. Dans les options du programme, tu peux configurer tes commentaires javaDoc en lignes (Inline Prefix //) avec un caractère de ton choix, rien n'impose que ce soit '/' pour faire ton inline en '///', même si c'est recommandé !

Figures toi qu'avant de t'en parlé, j'avais remarquer que l'on pouvait modifier la propriété 'Inline Prefix' je l'ai d'abord mis à '//', cela n'a rien changé... puis je l'ai mis à '///' et j'ai changé mes commentaires à '////' et alors là je vois toujours mes commentaires mais avec 1 '/' devant...

>Mettre du code en commentaires ? Beurk !

Cela sert tout simplement lors d'une modification hazardeuse (si, si, ça existe... surtout quand c codé avec les pieds...) il peut être intéressant de revenir en arrière, connaissant les affres de la loi de Murphi et sachant qu'un bug peut en cacher 1 autre (comme les trains... )... et ce, tant que le dit code n'est pas remonté dans le système de gestion de configuration...

Pourquoi n'écris-tu pas plutôt

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
//- CrashWindows(True);
ou encore 
//! CrashToutCourt;

Tu peux changer ta syntaxe ou jouer avec les options du programme pour que cela te convienne. Est-ce Clair pour toi ? Tiens moi au courant

l'idée est bonne merci... mais je vais sans doute choisir de préfixer les 'inline comment' avec '/!'...

Enfin j'ai une dernière remarque sur le soft, il serait également intéressant que l'outil réouvre le dernier projet ouvert, ou encore propose à l'utilisateur lors du lancement de l'appli s'il veux réouvrir le dernier projet...

@++, bidulechouet

[trident_job]

Au moins, vous manquez pas d'idées ! Et c'est appréciable ! 8)
Je regarde tout ça plus en détail ce week-end.

Bon week-end !

[Xander]

Bonjour à tous

depuis la version 0.10b, mes TAG return ne fonctionne plus.
Dans la doc généré, il ne m'affiche plus ce qu'il devrait afficher.

Voici un de mes commentaires dans lequel apparait le TAG :

(**
crée le code sql d'une requete
@return renvoi le code sql en question
**)

Si vous pouviez m'aider, ca m'arrangerais.

Merci d'avance

Xander

[Xander]

Bonjour

Nous avons discuté avec des collègues, au sujet de DCTD, et nous avons réfléchis à quelques petites choses qui seraient intéressantes.
Voici les trois points intéressant qui pourrait être rajouté :
- mettre un lien montant afin d'éviter de revenir toujours à l'index
- avoir la hiérarchie des objets
- récupérer la version du projet en cours (en récupérant celle présente dans projet --> option)

Voilà. Ce ne sont que des suggestions. Mais nous pensons que cela pourrait être intéressant.

Bonne journée à tous

Xander