Discussion :

[jackfirst72]

Bonjour,
J'ai fait différentes recherches et n'ai pas trouvé de réponse satisfaisante (à mon goût bien sûr ).
Plusieurs questions :

1. J'ai utilisé par le passé "DelphiCode2Doc" qui fonctionnait pas trop mal. Mais je me pose la question : existe-t-il un outil intégré à l'IDE 2010 pour génére la documentation de son code ?

2. J'ai pu voir qu'à partir de la vue "Modeling", on peut, normalement ..., exporter son modèle (génération la documentation). J'utilise une version Pro Delphi 2010 win32 et toute la configuration pour la génération de la doc est présente dans les options sous la rubrique "Modeling". Mais le menu "Generate documentation" n'existe pas ou est invisible dans l'IDE !

Merci d'avance.

[Franck SORIANO]

Je n'ai encore jamais cherché à utiliser ce genre de fonctionnalité.

Mais disons que depuis quelque temps déjà, Delphi supporte la documentation sous forme de commentaires XML :
Au début de chaque méthode, tu peux mettre un commentaire qui doit commencer par '///' (pour sous Visual Studio) pour décrire ce que fait la méthode.
Ensuite, tu as une option de compilation du projet qui permet de demander la génération de la documentation XML. Si tu l'actives, le compilateur générera un fichier xml pour chaque unité qui décrit les éléments contenus dans l'unité (déclaration de types, classes, méthodes, paramètres...) et qui contiendra également tes commentaire XML.
Par contre, il faut encore que tu mettes les fichiers XML en forme par tes propres moyens pour les présenter de façon utilisable.

La bonne nouvelle, c'est que tu peux également mettre tes propres tag xml dans le commentaire xml. Ils seront exportés en tant qu'éléments xml dans le fichier final.

PS: En fait, je viens de faire le test, si tu lances "Générer la documentation", il te fait également une présentation à la JavaDoc. Reste à voir si tu aimes le résultat... (perso je trouve ça horrible).

[sjrd]

Personnellement, je continue à utiliser DelphiCodeToDoc. Il répond à tous mes besoins.

[jackfirst72]

Merci Franck pour tes explications.
J'ai testé la génération de la doc XML. Cool. Il ne reste effectivement plus qu'à créer les fichiers XSL adélquats.
Par contre, tu as écris

si tu lances "Générer la documentation",

Où fais-tu cela ? Je ne vois à aucun endroit ce menu ? Merci d'avance.

sjrd : 2 questions pour toi.
1. DelphiCode2Doc s'intègre-t-il complètement à Delphi 2010 ?
2. Prend-t-il en compte correctement les génériques et toutes les nouveautés du langage depuis delphi 2007 ?

[sjrd]

1. DelphiCode2Doc s'intègre-t-il complètement à Delphi 2010 ?

Je l'utilise exclusivement en standalone, donc je ne peux pas te répondre.

2. Prend-t-il en compte correctement les génériques et toutes les nouveautés du langage depuis delphi 2007 ?

Oui, depuis la version v0.20 beta

[Franck SORIANO]

Où fais-tu cela ? Je ne vois à aucun endroit ce menu ? Merci d'avance.

Lorsque tu actives la modélisation du projet (onglet modèle sur le gestionnaire de projet), tu as cette option dans le menu contextuel du modèle.
Maintenant j'ai regardé sur un version Architecte. Il n'est pas impossible que l'option n'existe pas sur une Pro.

[jackfirst72]

Merci encore à vous deux pour vos réponses.

sjrd : je vais donc tester DelphiCode2Doc avec mon Delphi 2010 Pro afin de pousser cet outil dans ses retranchements afin de voir jusqu'où il tient.

Franck : Je pense effectivement aussi que ce menu n'est pas disponible en version Pro. J'ai joint un snapshot du menu que j'ai dans ma version lorsque je clique-droit sur le modèle. Dis-moi si cela correspond au tien, sans le menu qui m'intéresse Merci.