Version imprimable
Il existe deja un TAG "générique" qui permet de documenter l'interieur des fonctions, pour récuperer un algorithme par exemple.Citation:
Envoyé par philnext
Voir ici la description du TAG @comment :
http://dephicodetodoc.sourceforge.ne...dedComment.htm
Cela répond-il à ton besoin ?
La le mieux est que tu m'écrives un petit bout de programme, une unité de quelques lignes, avec exactement ce que tu voudrais avoir comme TAG.Citation:
Envoyé par philnext
Je te dirais si c'est possible !
Ok je pense que tu verras mieux avec un exemple (je m'y colle...).
Disons qu'en résumé le but c'est d'avoir, à partir d'un même source, plusieurs sorties de fichiers différentes.
Allez j'essaye de formaliser ma demande d'ici qq jours.
Alors, pas de nouvelles - bonne nouvelle ? :roll:Citation:
Envoyé par philnext
Bonjour Trident et bravo pour ce Javadoc version Delphi !
Nous sommes en train d’intégrer votre logiciel dans un simili processus de « Continuous Integration » à la sauce Java. Toutes les nuits on récupère les sources des codeurs depuis le dépôt svn, on créé dynamiquement le fichier xml de configuration, et on lance en ligne de commande DelphiCodeToDoc pour générer la doc en HTML, accessible depuis un serveur web interne.
Nous constatons cependant 2 problèmes :
1. Il semble qu’il y ait un bug dès lors qu’on référence plusieurs sources .DPR dans les balises <FilesIncludeList> : la génération se plante au 2ème fichier .DPR, avec pour motif l’incapacité à trouver les unités du .DPR. Il semble qu’il y ait confusion entre le chemin d’accès du 1er .DPR correctement parsé et le 2d ?
2. Ce point n’est pas un bug, et je comprends qu’il puisse être long à rajouter Cela concerne les indicateurs qualités qui n’apparaissent pas dans le cas d’un <OutputFormat> HTML. Peut-on imaginer en disposer un jour ? (où dois-je arriver à la conclusion qu’il me faut nous y coller !)
Merci encore,
Mc/
Je suis intéressé de savoir quel outil d'intégration continue vous utilisez (j'utilise CruiseControl.NET).Citation:
Envoyé par mctahiti
Chaque project de DelphiCodeToDoc doit avoir un seul DPR ou une liste de fichiers et / ou de répertoires (jokers possible 'machin*').Citation:
bug dès lors qu’on référence plusieurs sources .DPR dans les balises <FilesIncludeList>
Si vous voulez documenter plusieurs projets, il faut créer plusieurs fichiers de configuration. plusieurs documentations seront alors générées.
Il est effectivement prévu des ressortir les statistiques détaillés en format xml. Cela repondrait-il à votre attente ?Citation:
indicateurs qualités qui n’apparaissent pas dans le cas d’un <OutputFormat> HTML.
Pour l'instant je parle de "simili intégration continue" car nous n'avons intégré que la production journalière de notre doc avec suivi des indicateurs et fixation des objectifs.
Nous avons écrit tout cela en script batch "Cygwin" que nous portons sur un moteur (commercial) d'ordonnanceur. Mais rien de bien sorcier, cela se résume à automatiser de l'enchainement de commandes.
L'étape qui suit (début d'année 2008 peut-être) sera l'intégration des tests unitaires (DUnit) toujours en journaliers, avec production des indicateurs notamment de régression. La mécanique sera toujours la même : récupération des codes sources, compilation auto et parsing des résultats.
J'ai repéré CruiseControl avec sa possibilité d'intégration dans Delphi, mais je n'ai pas testé. Mais comme la mode est à Ruby maintenant, je me demandais si on allait pas utiliser ce truc puisque Borland propose des lib Delphi (compilation etc.).
Bref, pour le moment on n'en n'est qu'au début du processus.
Concernant DelphiCodeToDoc :
- Oui les statistiques détaillés en format xml c'est impeccable ! on pourra du coup facilement historiser en base pour faire de jolies courbes :)
- Pour l'unique .DPR c'est dommage, mais je comprends maintenant la logique.. je vais voir si on ne peut pas contourner cela par un artifice
- Dernière chose (s'il faut des idées !) : il serait intéressant d'avoir un recueille des tags "TODO" (activable ou non dans le fichier de conf XML, histoire de ne pas l'imposer) qui se présenterait de la forme :
Nom du fichier / Nom de la classe / Nom du membre
en cliquant sur le membre, on aurait ce qui existe déjà
en cliquant sur la classe, on aurait un tableau qui donnerait pour toute cette classe : le nom des membres / les tags TODO
en cliquant sur le nom du fichier on aurait un tableau qui donnerait pour tout le fichier : le nom des classes / le nom des membres / les tags TODO
et on pourrait imaginer une vue "de la racine" qui ferait la même chose mais sur tous les fichiers...
(je ne sais pas si c'est bien clair, mais je peux faire une petite doc pour ça!)
A bientôt,
Mc/
Pour que je comprenne bien le problème, peux-tu expliquer pourquoi il te faut une seule documentation pour plusieurs fichiers DPR ?Citation:
Envoyé par mctahiti
Je crois comprendre l'idée : un peu ce que l'on trouve dans l'interface de Delphi avec la gestion des TODO ? mais avec les TAG JavaDoc @todo, et à inclure dans la doc finale. Peux-tu m'envoyer un petit bout de fichier html du résultat attendu, pour confirmer cela ?Citation:
avoir un recueille des tags "TODO"
Je viens d'envoyer le petit bout de fichier html par email.
Concernant les DPR, l'objectif étant de n'avoir qu'un seul point d'entrée pour l'ensemble de nos objets métiers et projets, d'où cette nécessite de référencer plusieurs DPR.
Ce que nous allons à priori faire maintenant c'est autant de point d'entrée qu'il existe de projet + 1 point d'entrée pour nos objets métiers (qui sont utilisés dans tous nos projets).
Tient, peut-être un bug dans DCTD_cmd.exe :
je traite un projet, et il me donne une erreur "Exception TEParseError Unexpected token, expected "BEGIN".
Jusque là c'est normal, sauf que le code d'erreur de retour est 0, ce qui ne me permet pas de monter une alerte au développeur pour lui dire de revoir son dépôt.
Les autres erreurs renvoient bien 1, sauf celle là...
Autre chose, serait-il possible que les erreurs qui renvoient 1 en ligne de commande ne lève pas d'exception (objectif : éviter de bidouiller la base de registre pour ne pas avoir la boite de dialogue Windows de traitement des exceptions) ?
Merci,
Mc/
PS: nous avons modifier notre production de doc dans la logique DelphiCodeToDoc avec génération dynamique d'un fichier de conf XML par projet... la seule chose que ça rajoute, c'est la création d'une page HTML de récap de tous les projets, avec analyse du code d'erreur retourné pour indiquer si tout s'est bien passé ou pas...
je n'ai rien recu. voici mon adresse mailCitation:
Envoyé par mctahiti
trident_job@hotmail.com
oui, c'est bien un bug. J'ai ouvert un tracker ici :Citation:
Envoyé par mctahiti
http://sourceforge.net/tracker/index...81&atid=614255
merci pour l'info !
ANN: DelphiCodeToDoc v0.19Beta disponible - Outil gratuit de generation de documentation pour Delphi
La dernière version de DelphiCodeToDoc (v0.19Beta) est disponible. Elle peut être téléchargée ici :
http://downloads.sourceforge.net/dep...exe_v0.19b.zip
DelphiCodeToDoc est un outils gratuit de génération de documentation pour Delphi, distribué 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.
-----------------------------------------------------------------
Quelles sont les nouveautés de cette version ?
Cette version v0.19Beta contient les modifications suivantes :
:arrow: Correction du code retour de l'outil en ligne de commande lorsque le process echoue (Tracker 1830301)
:arrow: Refactoring des générateurs de document (générique + HTML)
:arrow: Correction d'une exception lors de l'utilisation de la visibilité AUTOMATED (Tracker 1736944)
:arrow: Correction des commentaires hérités pas toujours copiés de l'ancètre
:arrow: Correction des proprietés affichées à tor d'être documentées (Tracker 1735145)
:arrow: Correction d'une exception avec l'instruction {$ELSEIF} (Tracker 1732710)
:arrow: Correction d'une exception avec un record vide comme variable locale (Tracker 1732652)
:arrow: L'analyseur de commentaire ignorera maintenant les variables locales des fonctions
Quels sont les bugs connus du logiciel ?
*Generiques non-supportés (Tracker 1828114)
*Differences non justifiés entre champs et variables de classe
*Les traductions ne sont pas à jour
Quelles sont les limitations connues du programme ?
*Les variables de classe ne peuvent être commentées que par un commentaire inline juste après la declaration
*Les évenements n'ont pas de description
*Seul l'Anglais est disponible pour le document généré
*Le TAG @see n'est pas supporté
Quelles seront les futures évolutions ?
* Fix critical and major bugs
* Refactor generator code to improve reuse and subclassing (add another generator)
* Improve links between items in html documentation (Fields / assessors / class / sub-class links)
* Add an application configuration file (different from the project's configuration file)
Re-bonjour à tous,
La nouvelle version marche bien en effet, elle corrige les quelques bugs que j'avais notamment rencontré, reste plus qu'à espérer que notre développeur favori arrive à faire avancer les autres items :-)
A ce propos, serait-il possible d'avoir le dépôt de source en SVN plutôt que CVS ? Ca fait en effet un bail que je n'ai plus CVS installé sur mon poste, et je voulais récupérer le code source pour voir un peu comment c'était écrit (-> ne pas faire le raccourci "pour participer au développement" hein ! je voudrais juste jeter un oeil, pour qui sait, peut-être, un jour, quand j'aurais le temps, apporter une éventuelle contribution... remarquez tous les conditionnels que j'utilise !)
Merci, et bon courage pour la suite, on apprécie tous ces nouvelles versions!
Mc/
Je suis en train de faire la conversion du dépot CVS -> SVN, ca devrait venir d'ici le debut de l'année. Tu as eu une vision :king:Citation:
Envoyé par mctahiti
Je note donc que tu veux fortement contribuer au projet, très bien, je te donne les droits et je t'assignes tout de suite quelques Trackers à corriger ... ;o)
Je plaisante ... je te tiens au courant dès que SVN est operationnel, et si tu as des remarques / commentaires, critiques sur le code, je suis toujours preneur ! ;)
TridenT
Tient, bug trouvé ce jour (et posté sous le track 1855474) :
- le tag quality ne tient pas compte de la configuration mise dans "output filtering category", mais par contre la documentation en tient compte..
Ca serait d'ailleurs intéressant de séparer ce qu'on veut voir dans la doc (l'actuel "output filtering category" qui fonctionne bien) de ce que l'on veut suivre en terme d'indicateur qualité (une nouvelle section à créer, comme "tag quality filtering category").
A bientôt,
Mc/
Oui, je partage ton point de vue. Je vais travailler sur ce sujet dès que possible. J'aimerai aussi finir l'export des statistiques au format XML, ce qui servira aussi bcq !Citation:
Envoyé par mctahiti
Encore merci pour tes idées 8-)
ANN: DelphiCodeToDoc v0.20Beta disponible - Outil gratuit de generation de documentation pour Delphi
La dernière version de DelphiCodeToDoc (v0.20Beta) est disponible. Elle peut être téléchargée ici :
http://downloads.sourceforge.net/dep...exe_v0.20b.zip
DelphiCodeToDoc est un outils gratuit de génération de documentation pour Delphi, distribué 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.
-----------------------------------------------------------------
Quelles sont les nouveautés de cette version ?
Cette version v0.20Beta contient les modifications suivantes :
:arrow: Correction des "generics" qui crashent le parser (Tracker 1828114)
:arrow: Correction du double slash dans le chemin de sortie de la documentation
:arrow: Correction des commentaires après le END final qui génèrent une exception (Tracker 1870254)
:arrow: Correction des records dans une section VAR qui génèrent une exception (Tracker 1870547)
:arrow: Correction d'une exception avec les pointeur de fonctions constants (Tracker 1802084)
:arrow: Correction de résumé (summary) ajouté çà chaque construction du projet (Tracker 1835631)
:arrow: Correction de la génération vide (pas de fichiers) avec l'expert par défaut (Tracker 1867938)
Quels sont les bugs connus du logiciel ?
*Differences non justifiés entre champs et variables de classe
*Les traductions ne sont pas à jour
Quelles sont les limitations connues du programme ?
*Les variables de classe ne peuvent être commentées que par un commentaire inline juste après la declaration
*Les évenements n'ont pas de description
*Seul l'Anglais est disponible pour le document généré
*Le TAG @see n'est pas supporté
Quelles seront les futures évolutions ?
* Fix critical and major bugs
* Improve links between items in html documentation (Fields / assessors / class / sub-class links)
* Add an application configuration file (different from the project's configuration file)
iaorana everybody,
everybody iaorana,
J'ai essayé de "checkouter" le nouveau dépôt SVN de Delphicodetodoc et ça me donne un :
Error: REPORT of '/svnroot/dephicodetodoc/!svn/vcc/default': 400 Bad Request (http://dephicodetodoc.svn.sourceforge.net)
Suis-je le seul ?
Merci!
Mc/
Essaye avec ce chemin, ca ira mieux !Citation:
Envoyé par mctahiti
http://dephicodetodoc.svn.sourceforg...elphiCodeToDoc
Fa’itoito :P
Beuh !
Error: REPORT request failed on '/svnroot/dephicodetodoc/!svn/vcc/default'
Error: REPORT of '/svnroot/dephicodetodoc/!svn/vcc/default': 400 Bad Request (http://dephicodetodoc.svn.sourceforge.net)