Discussion :

[surferisback]

Bonjour,

J'essaie actuellement de commenter tout le code d'un projet en php. J'utilise PHPDocumentor. Ca fonctionne tres bien cependant j'aimerais ajouter des explications supplementaires sur la structure du code notamment en incluant des diagrammes de classe et autres schemas utiles a la comprehension du code.

J'ai lu la doc en ligne sur comment créer des tutorials avec phpDocumentor mais je n'arrive pas a générer les .pkg et je ne sais pas comment créer des liens vers les .pkg. Je suis completement perdu...

J'espere que quelqu'un peut m'éclairer sur comment générer une documentation en parrallele des commentaires ajoutés a mon code php.

[surferisback]

C'est bon j'ai trouver comment resoudre mon porbleme

Pour creer un tutorial :

• inserer le tag package dans le commentaire de votre classe (@package nomPackage)
• inserer le tag tutorial dans le commentaire de votre classe suivi du nom de fichier .pkg correspondant au tutorial (@tutorial tutorialDeLaClasse.pkg)
• creer un repertoire "tutorials" a la racine de votre projet puis un sous repertoire avec le nom du package qui contient votre classe. (@package nomDuPackage dans votreClasse.php)
• Dans le sous repertoire inserer le fichier .pkg correspondant au tutorial relatif a votre classe

En gros ca donne ca :

/**
* ma classe
*
* @package packageDeMaClasse
* @tutorial maClasse.pkg
*/

puis pour l'insertion de mon fichier tutorial

RacineProjet\tutorials\packageDeMaClasse\maClasse.pkg

Je ne sais pas si je suis claire...

[berceker united]

ça m'intéresse. Dans le fichier pkg il y a quoi ? Moi aussi je voudrais afficher les diagramme de classe correspondant sous un format vsd (vision) et zuml(poseidon)

[surferisback]

le fichier .pkg est en fait un fichier docBook. Je pensais pouvoir inserer des diagrammes dans des balises de type graphique mais phpdocumentor semble transformer que les balises <refentry> et ses enfants. Hors il n'y a pas moyen d'ajouter des images a l'aide de ses balises. Je suis un peu decu... Un tutorial sans screenshot et sans schema est beaucoup moins explicite a mon gout

Si quelqu'un a une idee sur la maniere d'inserer des images dans les pages tutorials de phpdocumentor...

[surferisback]

autant pour moi, il est possible d'inserer une image avec en prenant refentry comme dtd de base avec docbook. Il suffit d'ajouter une balise <graphic> dans votre .pkg comme ceci :

Code :

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

1
2
3
4
5
6
7
8
9
 
<?xml version="1.0"?>
<!DOCTYPE figure PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry>
       <refsect1>
		<graphic fileref="truc.jpg"/>
	</refsect1>
</refentry>

Ensuite si vous voulez definir plus d'attributs ou de balise il faut aller voir dans le options.ini de votre tempate HTML situe dans le dossier phpdocumentor\Converters\HTML\frames\templates\ .

Faites bien attention ou vous placez votre image. Apres la generation de votre documentation je place mon image la ou se situe mon fichier tutorial.html

[berceker united]

Ceci m'intéresse grandement et je pense que ça va intéresser d'autre personnes. Serait-ce trop demander si tu pouvais faire un petit tuto de ce que tu as appris en le proposant au modo ?