24

April
2009

Tutoriel : comment générer une PHPDoc avec Eclipse

category: All
by admin,
tags :none

Exemple avec WAMP server sous Windows.
Il faut au préalable installer le paquet PEAR PHPDocumentor à votre PHP.
(ex d’installation PEAR avec WAMP server)
Retourner dans Eclipse, puis cliquer dans le menu sur : Run/External Tools/External Tools Configurations

exemple de configuration phpdoc dans eclipse

exemple de configuration phpdoc dans eclipse

Sélectionner “Program” puis créer un nouveau.
Dans la fenêtre qui s’ouvre, lui donner un nom (nom de votre phpDoc).
Dans “Location” il faut indiquer le chemin de l’exe de PHP5.

Puis dans argument :
“C:\wamp\bin\php\php5.2.9\PEAR\PhpDocumentor\phpDocumentor\phpdoc.inc” -t ${project_loc}/CHEMIN_OU_GENERER_LA_DOC -o HTML:Smarty:PHP -d ${project_loc}

C:\wamp\bin\php\php5.2.9\PEAR\PhpDocumentor\phpDocumentor\phpdoc.inc = chemin du fichier de conf de la PHPDoc (ne pas omettre les guillements).

D’autres options peuvent être ajoutées (descriptif ici) à la suite des arguments.
Par ex : “-i test.php” pour ignorer le fichier test.php
Aussi “-pp” pour que la doc décrive aussi les méthodes privées.

Ce qui donne comme argument final par ex:
“C:\wamp\bin\php\php5.2.9\PEAR\PhpDocumentor\phpDocumentor\phpdoc.inc” -t ${project_loc}/SPIdoc -o HTML:Smarty:PHP -d ${project_loc} -i test.php -pp

Ensuite, pour générer la PHPDoc du projet en cours, il suffit de cliquer dans le menu sur Run/External Tools/Nom de votre phpDoc


|



Comments

Name (required)

Email (required)

Website

Leave a comment

*
To prove you're a person (not a spam script), type the security word shown in the picture. Click on the picture to hear an audio file of the word.
Click to hear an audio file of the anti-spam word

3 Comments so far

  1. Tutoriel : comment générer une PHPDoc avec Eclipse : BSoft&Co | 31 May 2009, 17:59

    [...] more: Tutoriel : comment générer une PHPDoc avec Eclipse : BSoft&Co Share and [...]

  2. osurus | 07 October 2009, 11:48

    Alors la je dis Merci, un grand merci….
    Enfin je vais pouvoir faire mes docs…

  3. Installer PHPDocumentor avec WAMP - Armetiz – Thomas Tourlourat | 19 January 2010, 16:49

    [...] je vous laisse avec la documentation officiel de PHPDocumentor ainsi qu’un tutoriel pour son utilisation avec Eclipse. Vous avez aimé l'article ? Alors vous aimerez surement : Des jeux Vidéos sur la Freebox [...]