Delphi + JavaDoc = DelphiCodeToDoc [Trucs & Astuces]

**trident_job** · 26/02/2008, 09h21

J'ai essayé sur 2 PCs différents, et même au boulot, pas de problème.
Je n'ai pas de paramétrage spécifique, voici la copie d'écran avant de faire OK.

Si cela ne fonctionne toujours pas, peux-tu m'envoyer qcq infos sur ta config et ton SVN.

**trident_job** · 28/02/2008, 13h59

Envoyé par trident_job

Si cela ne fonctionne toujours pas, peux-tu m'envoyer qcq infos sur ta config et ton SVN.

Alors, toujours des problèmes d'accès à SVN ?

**mctahiti** · 07/03/2008, 02h13

Salut Trident,

Je n'avais pas pu me replonger dedans avant ce jour. En fait ça vient de la connexion HTTP, et le serveur distant qui me jete sur la requète PROPFIND (erreur 405). Çà vient à priori du http://, car quand je passe en https:// ça passe...

Bizarre... Peut-être Sourceforge qui ne livre qu'en https ? En tous les cas ça y est, c'est en train de monter là...

Merci !
Mc/

**sjrd** · 07/03/2008, 11h00

En effet, le Subversion de SourceForge ne passe qu'en https. C'est indiqué dans leur documentation.

**trident_job** · 07/03/2008, 15h02

En effet, le Subversion de SourceForge ne passe qu'en https. C'est indiqué dans leur documentation.

Pour ma part, j'arrive à faire un checkout (anonyme) en http, quelquesoit le projet (DelphiCodeToDoc et autres).

Ce doit être le commit qui doit être fait en https non ?
Si tu trouves le lien vers la doc de sf.net, ça m'interresse.

**sjrd** · 07/03/2008, 22h07

Ben tu vas dans un projet -> Code -> Instructions sur SVN. Tu tombes là-dessus :
http://alexandria.wiki.sourceforge.n...or+Source+Code

**Bzc.Bzh** · 17/03/2008, 13h27

Bonjour,
J'utilise DCTD depuis quelques jours et je suis loin d'avoir exploité toutes ses possibilités (il me semble) mais je me demandais s'il existait un moyen de visualiser sous forme graphique les appels entre fonction à la manière de Doxigen (mais j'ai des doutes car je n'ai rien lu le laissant supposé).
Merci

**trident_job** · 18/03/2008, 09h00

Envoyé par Bzc.Bzh

s'il existait un moyen de visualiser sous forme graphique les appels entre fonction à la manière de Doxigen

Non, pas encore, c'est prévu, avec des graphes aussi pour les classes, mais pas encore !
Si je trouve un bonne âme pour l'aider

**Bzc.Bzh** · 18/03/2008, 11h03

Envoyé par trident_job

Non, pas encore, c'est prévu, avec des graphes aussi pour les classes, mais pas encore !

Ok, merci pour cette info. Et merci pour cet outil bien pratique

**sapin** · 09/04/2008, 13h27

Bonjour,
Merci pour ce programme que je vient de découvrir et qui va m'etre bien utile.
Par contre j'ai un petit soucis au niveau de la génération automatique de commentaire. En effet, j'ai installé Gexpert puis inclus ton fichier xml comme expliqué dans la vidéo, mais la macro CTRL + P ne fonctionne pas chez moi, contrairement à la macro CTRL + U qui fonctionne bien.

Si j'appuie deux fois de suite sur CTRL + P, le caractere suivant s'affiche

Est ce que quelqu'un à une idée ?
Merci

Edit : j'ai remplacer la macro CTRL + P par CTRL + * est ca marche. Mais ma question tient toujours, je cherche a comprendre pourquoi ca ne marcher pas. Merci

**trident_job** · 11/04/2008, 15h19

J'ai effectivement le même problème avec une nouvelle installation de Delphi2007. Le raccourci doit être utilisé pour autre chose, je ne sais pas quoi.

Ca marche avec certaine touche, et d'autre non.

Je ne sais pas qui utilise le CTRL+P ... je ne sais même pas si c'est Delphi2007 qui l'utilise (windows ?).

TridenT

**sapin** · 14/04/2008, 10h44

en tous cas, c'est pas l'imprimante qui est appelé par ce racourci.
Heuresement

**mctahiti** · 14/04/2008, 22h32

Bonjour à tous,

L'utilisation des commentaires DCTD doit obligatoirement se faire avant la déclaration de la méthode et/ou propriété à documenter.

Or certains générateurs de codes (l'excellent DAO InstantObject par exemple) positionnent leur code immédiatement avant la déclaration suivante par ordre alphabétique.

Exemple. Mon code d'origine :

{*
Statut du ticket
}
function TTicket.GetStatus: string;
begin
Result := _Status.Value;
end;

Au travers du framework je rajoute une propriété "Remote", qui va donc automatiquement me créer un GetRemote et un SetRemote. Ainsi je me retrouve avec :

{*
Statut du ticket
}
function TTicket.GetRemote: string;
begin
Result := _Remote.Value;
end;

function TTicket.GetStatus: string;
begin
Result := _Status.Value;
end;

L'inverse est vrai : si je supprime une propriété depuis le framework, le code est supprimé, mais pas le commentaire.

J'ai fais des essais en positionnant les commentaires entre la déclaration et le begin. Là, tout fonctionne bien : le commentaire reste dans la bonne section, et en cas de suppression, l'ensemble est bien supprimé. Voilà ce que ça donne :

function TTicket.GetRemote: string;
begin
Result := _Remote.Value;
end;

function TTicket.GetStatus: string;
{*
Statut du ticket
}
begin
Result := _Status.Value;
end;

Le 2d intérêt que j'y vois est que si on utilise les fonctions graphiques de l'IDE de dégroupement / regroupement, cela évite les surcharges de commentaires.

Seul soucis : DCTD "ne voit pas" les commentaires ainsi positionnés.

Ma question est simple : est-ce envisageable simplement (avec ou sans option) ?

A bientôt,
Mc/

**trident_job** · 15/04/2008, 13h20

Oui, c'est une demande fréquente

que je prendrais en compte dès que possible. Effectivement, cela sera compatible avec l'IDE de Delphi !

Ce sera bien sûr une option de DCTD, comme cela, chacun choisira sa façon de faire.

par contre, je ne peux pas donner de date, mon temps pour developper ces fonctionnalité et corriger des bugs est assez réduit ces derniers temps.

**trident_job** · 01/01/2009, 15h20

ANN: DelphiCodeToDoc v0.21Beta disponible - Outil gratuit de generation de documentation pour Delphi

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

http://downloads.sourceforge.net/dep...exe_v0.21b.zip

DelphiCodeToDoc est un outil gratuit de génération de documentation pour Delphi, distribué sous la licence GNU - GPL. Il utilise les informations contenues dans le code source, comme les symboles et les commentaires formaté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.21Beta contient les modifications suivantes :

Correction de l'option AllowHtmlInDescription inversée

L'application est maintenant complètement unicode - gestion des chaines unicode de Delphi2009 (Tracker 1055059)

Ajout du support des méthodes anonymes de Delphi2009

Ajout d'un fichier de configuration de DCTD pour sauvegarder la langue utilisée (Tracker 1680457)

Corrections de divers crash du parser (out keyword, unicode, Empty class var, offset keyword)

Mise à jour du html produit pour être conforme XHTML 1.0 Transitional

Correction des chemins relatifs (dans le fichier projet) qui ne fonctionnaient pas en ligne de commande (Tracker 2272357)

Ajout d'une option pour utiliser un CSS personnel au lieu de celui fourni en standard (Tracker 875929)

Quels sont les bugs connus du logiciel ?

Différences non justifiées 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 déclaration

Les événements 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

**trident_job** · 05/01/2009, 00h33

Pour répondre à mctahiti et pour tous ceux qui sont interressés :
Une nouvelle version v0.21beta.1 est disponible en test. Cette version supporte les commentaires écrits après la déclaration de la procédure (entre procedure et begin).

exemple:

Code :

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
 
procedure TNewClass.MyProc(const MyProcParam : integer);
{*-------------------------------------------
  Comment MyProc !
  @param MyProcParam Comment MyProcParam !
---------------------------------------------}
begin
  // dummy
end;
 
procedure TNewClass.AnotherProc;
/// Comment AnotherProc !
begin
  // dummy
end;

Le lien de téléchargement (vers la dernière version de test) ici :
http://trident.job.free.fr/delphicod...iCodeToDoc.zip

bon, j'ai travailler à mort ce soir sur cette fonctionnalité, je vais me coucher

**mctahiti** · 05/01/2009, 20h03

hiiyaa ! voilà un super cadeau de nouvelle année !
un grand merci à trident pour tous ces efforts au bénéfice de la communauté...

je m'en vais tester cette béta et la faire tourner sur nos codes InstantObjects (car c'était bien là que ça posait le plus de problèmes - pour tous ceux qui ne connaissent pas encore ce DAO, allez sur www.instantobjects.org et arrêtez définitivement l'écriture de requète SQL au profit d'un monde 100% objet - une requète complexe que vous mettiez 10mns à écrire auparavant se réduira à 30sec avec cet ORM)

(et d'ici 1 mois ou 2 je devrais aussi avoir une belle annonce à faire pour la communauté Delphi open-source)

à bientôt,
Mc/

**mctahiti** · 10/01/2009, 02h02

Trident est-ce que je peux me permettre de te demander le binaire de ta version en ligne de commande ? Ou bien si tu as déjà posté tes modifications sur le SVN je peux aussi le récupérer et le compiler...

**trident_job** · 10/01/2009, 20h02

Effectivement, il faut que j'ajoute la ligne de commande dans le dailybuild aussi.
Je viens de la mettre à jour !

http://trident.job.free.fr/delphicod...iCodeToDoc.zip

**trident_job** · 12/01/2009, 22h29

Merci à vous tous, visiteurs/membres/moderateurs de developpez.net pour votre soutient et vos messages/idées/tests/bugs et coups de gueule !

ANN: DelphiCodeToDoc v0.22Beta disponible - Outil gratuit de generation de documentation pour Delphi

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

http://downloads.sourceforge.net/dep...exe_v0.22b.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.22Beta contient les modifications suivantes :

Ajout de la reconnaissance des commentaires entre la déclaration de la procédure et le BEGIN

Modification du html généré maintenant au format UTF8

Modification du parser pour analyser les spécificités du freepascal (exposant **, operator ...)

Correction de l'execution de HHC qui retournait des caractères étranges

Correction de bugs (Tracker 2488024, 2487028)

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

Delphi + JavaDoc = DelphiCodeToDoc [Trucs & Astuces]

Outils Delphi

Discussions similaires

Partager

Partager