problme sur constante d'une unit
Free documentation system for Delphi / Pascal with JavaDoc support.
Status: Beta
Brought to you by:
trident
Menu
▾
▴
Salut,
Encore bravo pour l'exlent gnrateur de doc.
Ca marche nikel, j'ai juste un petit problme, dans une de mes units, j'ai dclar toutes mes constantes et le gnrateur de doc ne me met pas la description de ces constantes. J'ai essay plusieurs syntaxe pour les commentaires, quand je mets un "\\" aprs ma dclaration, au moment de parser mon fichier, le gnrateur me sort une erreur "error while parsing file".
Si tu as une petite ide sur mon problme tien moi au courant.
Merci.
La description des constantes n'est pas encore implmente.
Dans le rapport HTML, tu devrais voir ct de tes constantes "#UnderConstruction#".
Il est possible que cette fonctionnalit soit implmente dans la prochaine version (v0.5a), car j'ai dj commenc travaill dessus.
Il faut donc tre un peu patient.
La syntaxe utiliser ce moment l sera la mme que pour les classes, fonctions etc ... :
Soit '//' sur la ligne avant la constante.
Soit '//' sur la mme ligne que la constante.
Soit un TAG JavaDoc.
Merci pour ta remarque et tes encouragement.
TridenT
ok merci
j'ai une autre petite question, c'est sur les tag return, ils marche pas da,s la gnration. je sais pas si je les utilise bien.
aprs la description de ma fonction je met
@return "descriptif du retour de ma fonction"
j'oublie peut tre quelque chose?
Merci.
Oui, j'ai oubli de documenter le fait que le TAG @return n'tait pas implment dans la v0.4a.
Cel ne vient pas de toi !
Si jamais tu as un doute sur la syntaxe, va voir ici :
http://dephicodetodoc.sourceforge.net/JavaDoc_Syntax.htm
Je te confirme que ce TAG @return est dj implment dans le future v0.5a (qui devrait sortir d'ici une semaine 10 jours).
Je viens de finir ( l'instant) la correction sur les constantes, elle seront donc aussi documentes dans la v0.5a!
Si c'est pas du service rapide tout ca :)
Pour tre tenu au courant des nouvelles versions, tu peux t'inscrire sur la liste de diffusion ici :
http://lists.sourceforge.net/lists/listinfo/dephicodetodoc-news
ca pour une nouvelle, c'est une bonne nouvelle!!!
Des mises jour en temps rel, c'est la premire fois que je vois a!!
Avec le petit projet que j'ai a faire en delphi, je vais pouvoir chercher les bugs de ton gnrateur de doc, je te tiendrais au courant.
Je sais comme c'est trop chiant de dbugger, je vais me faire un plaisir de t'envoyer les bugs en temps rel!!! :)
merci et bon courage pour les finitions de la 0.5a
Re salut je viens de tlcharger la version 0.5 de DCTD, mais plus aucun de mes tags n'est pris en compte. Quand j'utilise la version 0.4, la gnration de doc se passe sans problme, mais avec la 0.5, il parse bien les fichiers mais j'ai #No TAG found in source code# partout ???
Si tu as une petite ide merci de me tenir au courant.
Bon courage @+.
Oui, il faut seulement modifier l'option "JavaDoc prefix".
http://dephicodetodoc.sourceforge.net/Project_Configuration.htm
En fait, cette option dfini quel prfixe tu utilises pour les TAGs JavaDoc.
Ainsi, si tes commentaires commencent par une toile '*', il faut lui indiqu.
Dans ton cas, je pense que tes commentaires n'ont pas de prfixe. Dans ce cas l, tu appuye sur la touche SUPPR, et l'option passe en '#0', donc aucun caractre de prfixe.
Et ca marchera comme avant.
TridenT
Les constantes sont documentes partir de la v0.6alpha.
TridenT
Correction orthographe : excellent s'crit ainsi
>je mets un "\" aprs ma dclaration
Tu veux dire "//" aprs une dclation ???
Un commentaire quoi !