Doxygen : bon format [Résolu]

[lionheart33806]

Bonjour,

Je n'arrive pas à trouver des liens sur comment bien documenter des sources php pour Doxygen.

Je dois sûrement mal chercher ...

Merci par avance

[guitou12]

J'avoue que je me casse un peu la tête aussi la dessus sur certains points.

Pour documenter du php le mieux et de reprendre la syntaxe phpdoc (@param , @return /** */, etc.) et ça colle à peu pres sous doxygen.

Ceci dit si tu ne fais QUE du php autant commenter en phpdoc (dans mon cas je documente aussi les scripts JS c'est pour ça que je galère un peu avec doxygen)

[lionheart33806]

Moi aussi, je devrais documenter le JavaScript ...

J'ai choisi Doxygen parce que ça m'a semblé 100 fois plus simple à mettre en place dans Eclipse (avec Eclox) que phpDocumentor.

Si tu me dis que pour le php je peux me caler sur phpDocumentator, je prends !

Pour JavaScript, sur quoi faut-il se caler ?

[guitou12]

Envoyé par lionheart33806

Moi aussi, je devrais documenter le JavaScript ...

J'ai choisi Doxygen parce que ça m'a semblé 100 fois plus simple à mettre en place dans Eclipse (avec Eclox) que phpDocumentor.

Si tu me dis que pour le php je peux me caler sur phpDocumentator, je prends !

Pour JavaScript, sur quoi faut-il se caler ?

Ben tu peux faire Doxygen pour JS, ceci dit ça va te faire 2 manips différentes pour générer de la doc qui ne sera pas au même format ni dans le même site etc...

Je te conseille de commenter tout en format Doxygen (mate le tuto sur le site officiel) ça sera plus simple (moi je galère un peu à cause de l'IDE que j'utilise mais si tu dév pas sous Zend ça t'es égal )

Voici un exemple de début de fichier js si ça t'intéresse

Code :

1
2
3
4
5
/** @defgroup scripts_admin Les scripts d'administration javascript
* Scripts des pages d'administration
* \author Guillaume M
* @{
*/

Et la fin du fichier

Code :

1
2
// Fermeture du groupe Doxygen
// @}

Ca permets de définir des groupes pour les sources javascript (enfin bon c'est pour faire joli quoi ! )

Sinon pour les fonctions JS tu peux commenter comme ça

Code :

1
2
3
4
5
6
/**
* Formate la date à la volée lors d'une saisie.
* id est l'élément à considérer.
* Si on tape 08122006 pour 08/12/2006.
* Si on tape 081206 pour 08/12/2006.
*/

Enfin bon tu verras tout ça par toi même

[ePoX]

J'en profite pour poser une question su doxygene.... Est il possible de créer de vrai/faux namespace au niveau de la doc.

Je demande cela car j'iamerais bien structurer un peu ma doc en fonction de certains aspects ect
Seulement le mot cle namespace, ou package d'ailleurs, ne semble avoir aucune incidence avec mes fichiers php....

As tu une idée sur la manière de procéder pour créér des *namespace* dans ma doc ?

[guitou12]

Envoyé par ePoX

J'en profite pour poser une question su doxygene.... Est il possible de créer de vrai/faux namespace au niveau de la doc.

Je demande cela car j'iamerais bien structurer un peu ma doc en fonction de certains aspects ect
Seulement le mot cle namespace, ou package d'ailleurs, ne semble avoir aucune incidence avec mes fichiers php....

As tu une idée sur la manière de procéder pour créér des *namespace* dans ma doc ?

Là comme ça à brule pourpoint je ne sais pas trop, j'essaierai de regarder un peu plus tard.

[lionheart33806]

Je crois que j'ai dû mal comprendre.
Un commentaire du type :

Code :

1
2
3
4
/**
  * texte
  * @var type
**/

n'est pas reconnu.

Je continue mes recherches.

[lionheart33806]

Pour info, si un commentaire contient '@var', doxygen ignore le commentaire tout entier.

[iMaTh]

Deterage de post car j'vai pas en ajouté un pour si peu, voila j'ai installé eclox dans eclipse par l'installateur de plugin ou j'ai ajouté ça http://download.gna.org/eclox/update

Dans les preference j'ai une rubrique doxygen du coup c'est cool ça a l'air d'avoir installé mais en revanche je lance ou le front end pour pouvoir editer mes doxyfile et lancer la generation de doc ?

[foisse]

Salut, j'imagine que depuis tu as trouvé.
Au cas où ça puisse servir à d'autres, pour éditer les doxyfile il suffit de les ouvrir dans l'éditeur en double cliquant sur le fichier doxyfile dans l'explorateur de projet (PDT).