Discussion :

[hansaplast]

ce qui m'amenne a la prochaine question (que je gardait de cot� histoire de miantenir la lisibilit�) :
les motifs :

Code :

S�lectionner tout - Visualiser dans une fen�tre � part

1
2
3
  /**#@+ 
...
/**#@-*/

ca sert a quoi?
ou plutot comment on s'en sert?

on definit un motif exemple
@var int

on laisse le code php lui meme enumerer toutes ces var, puis on "ferme la balise" (/**#@-*/ ).

j'ai bien compris?

[siddh]

ben c est pour faire un traitement en boucle ca oui

Code :

S�lectionner tout - Visualiser dans une fen�tre � part

1
2
3
4
5
6
7
8
9
10
11
 
   /**#@+ 
   * @access private 
   * @var string 
   */ 
   private $file; 
   private $ext; 
   private $srcPath; 
   private $dstPath; 
   private $font; 
   /**#@-*/

ca va faire comme si j avais mis

Code :

S�lectionner tout - Visualiser dans une fen�tre � part

1
2
3
4
5
 
/**
* @access private
* @var String
*/

au dessus de chacun de ses attributs la

[hansaplast]

en tout cas, ca marche, merci!

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
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
/**
*classe dbg : DEBUG
*
*ce fichier contient le script servanr a créer une classe de debug
*@package surveillance
*@author bruno da silva stagiaire EDF DTG
*/
 
 
/**
*debug : classe de debug : affiche les info de debug en bas de page
*
*cette classe pour but d'aider a repérer les differents bug rencontrés, en affichant des info prédefinies dans le code.
*elle est defini par le controleur et est appelée par global $dbg dans n'importe quelle partie du code.
*a la fin du controleur, si les header n'ont pas ete modifiés, on affiche le resultat a l"ecanr
*et dans un fichier, sinon on ne les affiches que dans un fichier.
*@package surveillance
*/
class debug{
/**
*@var array $all tableau stockant toutes les string passé par la mthode store
*/
var $all;
/**
*@var string $last dernier element passé par la methode store
*/
var $last;
/**
*@var int $level niveau de debug : permet de n'afficher que le element >= a ce niveau
*/
var $level;//niveau de debug
/**
*@var bool $forceAff lance des echo a chaque fois q'un appel est lancé a la methode store : permet de debugger meme si le script plante
*/
var $forceAff;//sert a forcer store a faire des echo
/**
*@var bool $ecrire defini si il faut ecrire dans un fichier les info a la fin du script
*/
var $ecrire;

mais t'imagien que j'ai plein de questions!
(si t'en a marre tu le dit )

Class Variables

$all =
[line 24]

Tags:
var - tableau stockant toutes les string pass� par la mthode store
Type: array

Overrides:

ca note

$all=

il fait que je lui mette sa valeur par defaut ou c'est que pour lers static?

tags :

c'est quoi?

[siddh]

alors les tags c est @param @author @package .....

ben si t as pas de val a lui mettre par defaut tu lui en met pas

[sekaijin]

je ne sais pas vous mais chez moi je n'ai pas un seul d�veloppement qui fasse intervenir que du php j'ai toujour une dose de xml de xhtml de Javascript de Php

Doxygene �tant multi langage est pour mois le plus convainquant

A+JYT

[hansaplast]

j'avoue que t'a pas tort...
j'avait aps pens� au JS...

apres le XHTML... : marre de lire pleind e doc anglaise (au moins 10-20 heures toutes les deux semaines...) donc pour le moment je sait juste que c'est XML compiant et que certains disent que c'est pas bien car ca coupe trop le pont...blablabla.
l'interet c'est du xpath et du XSLT dessus?
ca tombe bien, je connait pas encore aussis!
(je suis tres organis� dans mes ignorances...)

[siddh]

euh me semble pas que doxygen fasse de la doc pour des sources js non ?

[elitost]

Ces outils de documentation sont assez facile � utiliser en fait.

Pour Doxygen, on peut l'utiliser en ligne de commande ou via une interface graphique qui permet d'enregistrer la configuration d'une g�n�ration de documentation.

Maintenant je te conseille de les tester et te faire ton propre avis.

[hansaplast]

heu...
le boulet est de retours!

au debut, tout marchait bien, je selectionnait fichier par fichier ce que je voulait scanner.
puis j'ai decid� de tester un repertoire en entier...
ca a ete super long, plein d'erreure car ca scan les subdirectory aussi..

puis j'ai voulut reparser un fichier, et un seul...
et la : mache plus...

j'ai test� en changeant la config (demo.ini) la ca a essay�, ca a mis 15mn ptet bien (generation d'un pdf) et a la fin : plantage...

depuis, je re-teste... et rien a faire, toujours le meme message d'erreure :

Notice: Undefined variable: masterPath in c:\php4\phpdocumentor\phpDocumentor\Io.inc on line 391

ps : j'utilise :

docBuilder :: phpDocumentor v1.3.0RC3 Web Interface

donc, je retourne sur le tutto,mais si quelqu'un savait..
merci pour tout

[hansaplast]

c'est bon, pb resolu...

[hansaplast]

par contre, j'ai une auatre question :

quand on a une fonction assez complexe, est qu'on eput documenter son fonctionnement a l'interieur du code, ou, faut il se conteter d'expliquer son fonctionnement dans l'entete de la fonction?

j'ai vu qu'on pouvait mettre en lien du code source, c'est la solution qu'ils on retenue?

[siddh]

ben tout ce qu il y a a l interieur n apparaitra pas dans la doc.

il faut bien detailler au dessus