Version imprimable
Nouveau ! :f1:
Voici une petite video pour présenter comment utiliser les templates de commentaires de GExperts pour ajouter en un clic des canevas de commentaires pour les méthodes et unités.
N'hésitez pas à donner votre avis ;) !
http://dephicodetodoc.sourceforge.ne...tsTemplate.htm
ANN: DelphiCodeToDoc v0.16Beta disponible - Outil gratuit de generation de documentation pour Delphi
La dernière version de DelphiCodeToDoc (v0.16Beta) est disponible. Elle peut être téléchargée ici :
http://prdownloads.sourceforge.net/d...b.zip?download
-----------------------------------------------------------------
Quelles sont les nouveautés de cette version ?
Cette version v0.16Beta contient les modifications suivantes :
:arrow: Correction d'une assertion avec trop de neuds enfants (Tracker 1510470)
:arrow: Possibilité d'avoir le répertoire de sortie en chemin relatif (Tracker 1549273)
:arrow: Correction des liens précédent / suivant dans la documentation HTML et CHM
:arrow: Suppression des espaces dans les listes de fichiers à inclure / exclure
:arrow: Correction d'une assertion avec une constante définie dans une classe avant un identifiant de visibilité (Tracker 1516235)
:arrow: Correction d'une exception avec un mot-clé réservé dans un identifiant (Tracker 1516226)
:arrow: Correction d'un problème de delimiter de chemin pour compatibilité avec la dernière JCL (Tracker 1547733)
:arrow: Correction du mot-clé UNSAFE qui génère une exception (Tracker 1548390)
:arrow: Ajout des mots-clé assembleur VMTOFFSET and DMTOFFSET non reconnus (Tracker 1552479)
:arrow: Correction d'une regression lors de la construction des listes de constantes, variables, et fonctions
:arrow: Correction d'un appel à HHC pouvant échouer (Tracker 1547734)
:arrow: Correction de classes non-générée en décochant l'option mvPrivate (Tracker 1547737 )
:arrow: Ajout de la possibilité d'utilisiser des chemins relatifs dans la liste des fichiers inclus au projet (Tracker 1547740, 1204843)
:arrow: Ajout de la prise en compte des masques de fichier (joker) dans la liste des exclusions (Tracker 1547741)
:arrow: Correction des caracteres invalides dans le menu (charset changed from ANSI to DEFAULT)
:arrow: Ajout d'une option pour afficher les objets cachés (définis uniquement dans l'implémentation) (Tracker 1478189)
Quels sont les bugs connus du logiciel ?
*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 ?
*Support des records
*Controle de la couverture de comentaire
*Arbre des classes
*Generateur XML / XSLT
Salut,
je vais regarder tes templates et la nouvelle version.
:ccool:
J'aime beaucoup ces nouvelles fonctionnalités :D :
Et :merci: pour les VMTOFFSET :)Citation:
Envoyé par trident_job
Oui, fort sympathiques ces fonctionnalités, j'espère qu'il y en aura d'autres du même type :roll:Citation:
Envoyé par sjrd
Pour le VMTOFFSET, j'avoue que je n'avais pas souvent vu ce mot-clé assembleur ... on en apprend tous les jours ;)
Concernant le template pour GExpert, la clause return, dans le détail des paramètres d'une méthode, contient le type de donnée renvoyée. Ce n'est pas nécessaire car le soft, lors de la compilation du .chm, le renseigne déjà.
La ligne suivante du fichier XML :
peut être remplacée par :Citation:
%ENDPARAMLIST%@return %RESULT% ResultDescription
Avec cette macro il n'y a plus d'excuse pour ne pas document son code.Citation:
%ENDPARAMLIST%@return ResultDescription
Bravo.
yes, je vais le modifier, bien vu.
C'est clair ! Je suis en train de finir une visualisation des items non-renseignés (classes, methodes, paramètres, constantes ...).Citation:
Avec cette macro il n'y a plus d'excuse pour ne pas document son code.
Alors là, celui qui ne le fait pas, il est de mauvaise fois !
Bientôt une V1 alors.Citation:
Envoyé par trident_job
Sinon je t'ai posté un msg dans le forum français sur SourceForge concernant un msg d'erreur sans gravité qui est affiché lors de la compilation.
bonjour aux lecteurs de ce post.
Après un temps d'absence:roll: , DelphiCodeToDoc revient avec quelques nouveatés :
* Couverture de commentaires
* Arbre des classes
* Corrections de bug
Avant de finaliser cette future version (il reste encore des choses à faire!), je souhaitais soumettre la version en cours à votre oeil critique :
* Que pensez-vous des informations présentes dans l'onglet Comment Quality ?
* Que pensez-vous de la présentation ?
N'hésitez pas à m'envoyer vos remarques / critiques / idées, elles sont toujours appréciées 8-) .
Téléchargement de l'EXE (extrait de CVS) :
http://dephicodetodoc.cvs.sourceforg...iCodeToDoc.exe
Les modifications (en anglais):
* Refactored Structure Sort using a Visitor
* Fixed Config file date changed even if not modified (Tracker 1604036)
* Added TAG coverage detail for each node
* Added Tag coverage summary in mainform
* Added brazillian portuguese translations
* Fixed Parse Error with &variable syntax (Tracker 1589861)
* Updated visitor for DocTemplate
* Fixed Comments not included with different method declaration (Interface and Implementation) (Tracker 1337626)
* Added Quality comments coverage visualization
* Added simple comments coverage statistics
* Fixed varargs keyword generate an exception (Tracker 1607892)
* Fixed Parser exception with tabs after final end (Tracker 1601763)
* Fixed Parser exception with the deprecated directive (Tracker 1581963)
* Added Class tree (text format) in the documentation
* Added Chinese translations (traditional and simplified)
* Fixed Exports in unit throw an exception (Tracker 1402652)
Les points en cours :
* #TODO# Fix option ParseImplementation
* #TODO# Update translation html page
* #TOFIX# Verify Nested type in TDOCClass
* #TOFIX# Merge TDOCVars and TDOCFields
* #TODO# Add support for records as class ?
* #TOFIX# Test Multiple variable declaration in one line (comma separated)
C'est vraiment très intéressant :ccool:
Mais il y a un truc qui personnellement me dérange : il s'agit des chaînes de ressources. En effet, je ne les documente jamais, parce que ça rend mon code illisible et que de toute façon ce serait pour remettre le contenu de la chaîne en description.
Du coup j'ai pas mal de rouge sur toutes mes constantes chaînes. Et j'ai plus de mal à repérer les "vrais" manquant.
Serait-il possible d'avoir une option pour documenter automatiquement les constantes non documentées avec leur valeur ? Et ne pas émettre d'avertissement ?
En tous cas c'est du très beau boulot :D Bravo pour ce logiciel :D
Pour les ResourceStrings, il y a deja une demande ici : http://sourceforge.net/tracker/index...81&atid=614258
Je vais voir si je peux le faire assez facilement, car je dois modifier le parser pour cette detection.
En tout cas, ta demande est jsutifiée, car les commentaires des resourcestring ne sont pas très utiles, effectivement.
Merci pour tes retours (rapides).
TridenT
:merci:Citation:
Envoyé par trident_job
Tu sais bien que je suis fan de ton prog :PCitation:
Envoyé par trident_job
ANN: DelphiCodeToDoc v0.17Beta disponible - Outil gratuit de generation de documentation pour Delphi
La dernière version de DelphiCodeToDoc (v0.17Beta) est disponible. Elle peut être téléchargée ici :
http://downloads.sourceforge.net/dep...exe_v0.17b.zip
-----------------------------------------------------------------
Quelles sont les nouveautés de cette version ?
Cette version v0.16Beta contient les modifications suivantes :
:arrow: Added support for record and extended record (D2006) as class (Tracker 1168150)
:arrow: Fixed Field comments for Records don't work right (Tracker 1534349)
:arrow: Fixed Method on records not parsed (Tracker 1649093)
:arrow: Added Quality comments coverage visualization
:arrow: Added simple comments coverage statistics
:arrow: Added Tag coverage summary in mainform
:arrow: Added TAG coverage detail for each node
:arrow: Added inheritance for comments of override methods (Tracker 1648834)
:arrow: Fixed Impossible to change copyrigth information in html footer (Tracker 1702094)
:arrow: Added support for UTF8 source files
:arrow: Fixed Parsing function in implementation section (Tracker 1635904)
:arrow: Fixed CHM files not generated in a specific folder
:arrow: Moved CSS file to a new resource folder
:arrow: Fixed Links section is always displayed as #UNDER_CONSTRUCTION# (Tracker 1672418)
:arrow: Fixed Parser exception with assembly attributes (Tracker 1649782)
:arrow: Updated JCL/JVCL package to JVCL330CompleteJCL198-Build2509
:arrow: Fixed Multiple variable declaration in one line not recognized
:arrow: Fixed a Memory Leak with TDOCClassesTree missing destructor
:arrow: Added Warn when "Included Files list" is empty (Tracker 1623150)
:arrow: Removed unused units (converters and BasicStats)
:arrow: Refactored Structure Sort using a Visitor
:arrow: Fixed Config file date changed even if not modified (Tracker 1604036)
:arrow: Added brazillian portuguese translations
:arrow: Fixed Parse Error with &variable syntax (Tracker 1589861)
:arrow: Updated visitor for DocTemplate
:arrow: Fixed Comments not included with different method declaration (Interface and Implementation) (Tracker 1337626)
:arrow: Fixed varargs keyword generate an exception (Tracker 1607892)
:arrow: Fixed Parser exception with tabs after final end (Tracker 1601763)
:arrow: Fixed Parser exception with the deprecated directive (Tracker 1581963)
:arrow: Added Class tree (text format) in the documentation
:arrow: Added Chinese translations (traditional and simplified)
:arrow: Fixed Exports in unit throw an exception (Tracker 1402652)
Quels sont les bugs connus du logiciel ?
*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 ?
*Generateur XML / XSLT
Merci pour cette nouvelle version.
Malheureusement j'ai plusieurs fois ce message lors du parsing de mon projet :
Exception EAccessViolation Access violation at address 004E29CA in module 'DelphiCodeToDoc.exe'. Read of address 00000000
La version 0.16 marchait par contre très bien, je vais rester avec elle en attendant.
Et encore merci pour ce super outil malgré tout.
Sovitec
Salut, j'aimerais avoir plus d'information sur ces problèmes. Peux-tu m'envoyer la fenêtre de log, et eventuellement, le fichier ou un morceau du fichier incriminé. Cela m'aidera à identifier puis corriger rapidement le problème. Sinon, sans informations ... c'est difficile !Citation:
Malheureusement j'ai plusieurs fois ce message lors du parsing de mon projet
Il y a eu bcq de changement dans l'architecture et le parser, mais jusqu'à maintenant, tout mes tests DUnit passent, donc ce doit être un nouveau problème.
ANN: DelphiCodeToDoc v0.18Beta disponible - Outil gratuit de generation de documentation pour Delphi
La dernière version de DelphiCodeToDoc (v0.18Beta) est disponible. Elle peut être téléchargée ici :
http://downloads.sourceforge.net/dep...exe_v0.18b.zip
-----------------------------------------------------------------
Quelles sont les nouveautés de cette version ?
Cette version v0.18Beta contient les modifications suivantes :
:arrow: Correction des 'packed record' non affichés dans la documentation (Tracker 1723230)
:arrow: Ajout du support des types de fonction (Tracker 1551120)
:arrow: Correction d'une exception du parser avec les types de fonction (Tracker 1719702, 1719213)
:arrow: Correction d'une exception avec les 'Variant record' ou UNION (Tracker 1719703)
Quels sont les bugs connus du logiciel ?
*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 ?
*Generateur XML / XSLT
bonjour,
quelques utilisateurs ont eu droit à des exceptions du parser sur la dernière version.
Ces deux problèmes sont :
1/ Parser Exception on {$ELSEIF} statement => voir http://sourceforge.net/tracker/index...81&atid=614255
2/ Exception with empty records => voir http://sourceforge.net/tracker/index...81&atid=614255
J'ai corrigé ces deux problèmes, une nouvelle version temporaire est disponible sous le numéro v0.18beta.1
DelphiCodeToDoc Executable
http://dephicodetodoc.cvs.sourceforg...athrev=v0_18b1
DCTD_cmd command line executable
http://dephicodetodoc.cvs.sourceforg...athrev=v0_18b1
Vous pouvez télécharger et copier ces fichiers dans votre répertoire de DelphiCodeToDoc. Rappelez-vous que :
* C'est une version non-officielle, partiellement testée et toujours en developpement.
* Pas de traductions embarquées dans l'EXEcutable.
* Si vous trouvez d'autres bugs, envoyez-moi un mail ou ouvrez un Tracker dans l'interface de SourceForge.
merci à tous pour vos encouragements et vos remontées de bugs. :roll:
TridenT
Bonjour
Je commence à utiliser DCTD pour mes sources même si je me suis interessé au produit pour d'autres raisons à l'origine.
Voilà ma demande :
En plus de commenter mes sources j'aimerais utiliser DCTD pour d'autres fonctionnalités :
=Documenter d'autres points de mon projet notamment les tables utilisées dans ma base de données.
=Gérer les versions...
Le but étant de générer un doument par fonctionnalités.
Quelqu'un a une idée ??
PS : j'ai déja posté qq chose de similaire dans le forum de SourceForge.
DCTD te permet de documenter le code, donc si les tables sont représentée dans le code des unités, alors oui.Citation:
Envoyé par philnext
C'est à dire ? Détailles ta demande.Citation:
Envoyé par philnext
Oui, j'ai aussi vu ton post sur le site de sourceforge !
Merci pour la réponse du coup je me lance dans les explications...
Aujourd'hui j'utilise DCTD pour générer la doc de mon code et tout va bien.
Mais j'ai quelques autres besoins :
1/ Fournir aussi une doc à des partenaires qui vont travailler sur la base de données que je crée.
Pour cela j'aimerais créer une autre doc que celle de mon soft mais toujours à partir de mon source. Bien sûr je n'ai pas besoin que le parser aille vérifier la structure de la base mais simplement que je puisse avoir des tags particuliers pour ce besoin.
2/ Gérer les versions. Bon là le but est simplement de générer la doc. des évolutions de versions à jour. Chaque modification de code importante est documentée par un tag avec le N° de version, le type de modif (+ : fonction, - correctif, = autre) et le descriptif de la modif.
La doc générée fait juste ( !) une compilation des modif et classe tout par version.
Bon ce sont 2 exemples mais, je pense, significatifs de mes besoins.
Si tu veux un coup de main sur le soft, je peux t'aider, bien qu'un peu débordé ces temps ci.
Bon courage !