Discussion :

[hansaplast]

oui, je sait y'a bien :
http://cyberzoide.developpez.com/php4/phpdoc/
mais... je voudrait savoir quand meme lequel vous me conseillez entre phphDocumentor et Doxygen?

le plus de Doxygen : multiplateforme

le plus de phpDocumentor : le standart (je croit)

donc est-ce que Doxygen est une solution viable pour plusieurs language, ou chacun a t il sa solution phare a lui preférer? (je pense jaja, c++...)

merci bcp d'avance

ps: je suis sous windows

[elitost]

Le fait que Docygen soit utilisable avec plusieurs language est un grand plus.

Cela évite de vaporiser ses efforts sur plusieurs outils.

Cependant phpDocumentor reste un très bon outil.

[hansaplast]

Doxygen est il utilisable dans un environnement professionel?
est il utilisé?

@elitost :

bein l'un ou l'autre, voir l'un, voir l'autre

merci

[siddh]

pas testé doxygen mais il semble tres bien.

PhpDocumentor est bien.

[hansaplast]

bon, apparemment, les deux sont tres bien...
j'en conclu qu'ils sont fiable et tout et tout

mais une pitite question me taraude quand meme...
...mais ou il est le gant?

donc ma question est : lequel est le plus intuitif/rapide/facil a aprendre /tout en saisissant le moins de code?

non, serieux, le gant , il est dans la boite a gant...pfff

non, serieux, lequel est le plus accessible?

[siddh]

ben ecoutes moi j ai utilisé que phpdoc et je le trouve facile a utiliser en plus il est intégré dans certaines versions de zend.

[hansaplast]

et comment tu lance la compile de la doc?
en ligne de commande?

car je tourne sous une vielle version de php...

je suis sur leur site et je ne trouve pas d'info...
je continue ma recherche!

ps : merci de tes multiples reponses

[siddh]

avec phpdoc c est soit en ligne de commande, soit par une interface web
tu as aussi la possibilité de faire des scripts

[hansaplast]

merci

sait tu si il y a une version de php minimale requise?

(acces a certaines fonctions...)

[siddh]

ben a mon avis php 4 car c est surtout interressant quand tu fais de l objet

[the_jeck]

Moi j'utilise phpDocumentor... rien à redire, facile à utiliser avec l'interface web, la création d'un fichier .ini pour ne pas a avoir à reconfigurer la génération de la doc à chaque fois est très pratique...

Suffit d'être rigoureux dans la documentation de son code, mais ca, c'est pareil pour tous les générateurs de docs....

Pas essayé l'autre...

[hansaplast]

bon, ca marche avec ma version de php.
Merci

par contre :

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
40
41
/*
*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.
*
*
* @var array $all tableau stockant toutes les string passé par la mthode store
* @var string $last dernier element passé par la methode store
* @var int $level niveau de debug : permet de n'afficher que le element < a ce niveau
* @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 bool $ecrire defini si il faut ecrire dans un fichier les info a la fin du script
*/
class debug{
var $all;
var $last;
var $level;//niveau de debug
var $forceAff;//sert a forcer store a faire des echo
var $ecrire;
 
 
/*
* debug : constructeur de la classe
*
*tous les parametres sont optionels 
*
*@param int $level toutes les info de debugging d'un niveau inferieur a celui passé en paramettre seront affichée
*@param 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
*@param bool $ecrire defini si il faut ecrire dans un fichier les info a la fin du script
*
*
*/
	function debug($level = 0, $forceAff = false, $ecrire = true){
		$this->forceAff = $forceAff;
		$this->all = array();
		$this->level = $level;
		$this->ecrire = $ecrire;
		$this->store("Debug Actif, de niveau : {$level}", 1);
	}

devrait me donner des info en sortie, non?

parceque j'obtient :

Class Methods

debug
debug debug( [mixed $level = 0], [mixed $forceAff = false], [mixed $ecrire = true])

[line 37]

Parameters:
[ Top ]


afficheTout
void afficheTout( [mixed $level = false])

[line 64]

Parameters:
[ Top ]

et

Class Variables

$all =
[line 19]

Type: mixed

Overrides:

[ Top ]


$ecrire =
[line 23]

Type: mixed

Overrides:

[ Top ]


$forceAff =
[line 22]

Type: mixed

Overrides:

j'ai une erreure?
en tout ca :

To view errors and warnings, look at E:\Mes Sites\nouveau test ecomed\doc/errors.html
done

et le fichier contient :

Warning on line 17 - no @package tag was used in a DocBlock for class debug
Warning on line 103 - File "E:\Mes Sites\nouveau test ecomed\class\debug.class.php" has no page-level DocBlock, use @package in the first DocBlock to create one

je suis obligé de créer un package pour que me parse mon code?

en gros, la j'ai une classe debug et une classe log, je les met dans le meme package, avec eventuellement un sous package pour chaqune?

[siddh]

un exemple de commentaires interpretes pas phpdoc

[hansaplast]

j'ai cemessage :

Reading file E:/Mes Sites/nouveau test ecomed/class/debug.class.php -- Parsing file
WARNING in debug.class.php on line 18: no @package tag was used in a DocBlock for class debug
WARNING in debug.class.php on line 104: File "E:\Mes Sites\nouveau test ecomed\class\debug.class.php" has no page-level DocBlock, use @package in the first DocBlock to create one
done

alors que coté code j'ai :

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
<?php
 
/*
*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.
*
*
*@var array $all tableau stockant toutes les string passé par la mthode store
*@var string $last dernier element passé par la methode store
*@var int $level niveau de debug : permet de n'afficher que le element < a ce niveau
*@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 bool $ecrire defini si il faut ecrire dans un fichier les info a la fin du script
*@package surveillance
*/

(*@package surveillance = ligne 17)

je comprend po ^^

ps : merci pour le lien

[siddh]

les cartouches de comment doivent commencer par /** pas /*

[hansaplast]

merci!

[hansaplast]

j'ai encore des erreures :

Error on line 26 - DocBlock has multiple @var tags, illegal. ignoring additional tag "@var bool defini si il faut ecrire dans un fichier les info a la fin du script"
Error on line 26 - DocBlock has multiple @var tags, illegal. ignoring additional tag "@var bool lance des echo a chaque fois q'un appel est lancé a la methode store : permet de debugger meme si le script plante"
Error on line 26 - DocBlock has multiple @var tags, illegal. ignoring additional tag "@var int niveau de debug : permet de n'afficher que le element < a ce niveau"
Error on line 26 - DocBlock has multiple @var tags, illegal. ignoring additional tag "@var string dernier element passé par la methode store"

avec ce code :

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
/**
*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.
*
*
*@var array $all tableau stockant toutes les string passé par la mthode store
*@var string $last dernier element passé par la methode store
*@var int $level niveau de debug : permet de n'afficher que le element < a ce niveau
*@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 bool $ecrire defini si il faut ecrire dans un fichier les info a la fin du script
*@package surveillance
*/
class debug{
var $all;
var $last;
var $level;//niveau de debug
var $forceAff;//sert a forcer store a faire des echo
var $ecrire;

je ne defini pas mes var en private... c'est pour ca? (en meme temps c du phph4 donc always-public)

[siddh]

faut le faire pour chacune d entre elles de manière separée
et a l interieur de ta classe

[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