J'ai récupéré un site php en POO (avec des classes dédiées pour les
structure des données, les interactions avec la BD, le traitement des
données reçues du client, l'envoi de données au client, etc.). Je
voudrais le documenter de façon clean.
Qu'est ce qui existe comme outil facilitant la documentation ? J'ai vu
sur des articles anciens que PHPdoc était censé émuler JavaDoc mais il
semble en version beta depuis des lustres...
ARRETEZ DE POURRIR LE CODE SOURCE AVEC DU #@! DE BLABLA QUI N'A RIEN A Y FOUTRE.
<aol>Dans mes bras !!!</aol>
$dans_mes_bras++; // on ajoute 1 à $dans_mes_bras
MB -- Michel BILLAUD LABRI-Université Bordeaux I tel 05 4000 6922 / 05 5684 5792 351, cours de la Libération http://www.labri.fr/~billaud 33405 Talence (FRANCE)
Bruno Desthuilliers <bdesth.quelquechose@free.quelquepart.fr> writes:
John GALLET wrote:
ARRETEZ DE POURRIR LE CODE SOURCE AVEC DU #@! DE BLABLA QUI N'A RIEN
A Y
FOUTRE.
<aol>Dans mes bras !!!</aol>
$dans_mes_bras++; // on ajoute 1 à $dans_mes_bras
MB
--
Michel BILLAUD billaud@labri.fr
LABRI-Université Bordeaux I tel 05 4000 6922 / 05 5684 5792
351, cours de la Libération http://www.labri.fr/~billaud
33405 Talence (FRANCE)
ARRETEZ DE POURRIR LE CODE SOURCE AVEC DU #@! DE BLABLA QUI N'A RIEN A Y FOUTRE.
<aol>Dans mes bras !!!</aol>
$dans_mes_bras++; // on ajoute 1 à $dans_mes_bras
MB -- Michel BILLAUD LABRI-Université Bordeaux I tel 05 4000 6922 / 05 5684 5792 351, cours de la Libération http://www.labri.fr/~billaud 33405 Talence (FRANCE)
Olivier Miakinen
ARRETEZ DE POURRIR LE CODE SOURCE AVEC DU #@! DE BLABLA QUI N'A RIEN A Y FOUTRE.
<aol>Dans mes bras !!!</aol>
$dans_mes_bras++; // on ajoute 1 à $dans_mes_bras
/* * --- JMM 5/3/99 * Correction de l'erreur d'incrémentation de $dans_mes_bras * $dans_mes_bras--; (ancien code) * --- JMM 5/3/99 */ $dans_mes_bras++; // on ajoute 1 à $dans_mes_bras /* * --- JMM 5/3/99 * Fin de la correction * --- JMM 5/3/99 */
ARRETEZ DE POURRIR LE CODE SOURCE AVEC DU #@! DE BLABLA QUI N'A RIEN
A Y FOUTRE.
<aol>Dans mes bras !!!</aol>
$dans_mes_bras++; // on ajoute 1 à $dans_mes_bras
/*
* --- JMM 5/3/99
* Correction de l'erreur d'incrémentation de $dans_mes_bras
* $dans_mes_bras--; (ancien code)
* --- JMM 5/3/99
*/
$dans_mes_bras++; // on ajoute 1 à $dans_mes_bras
/*
* --- JMM 5/3/99
* Fin de la correction
* --- JMM 5/3/99
*/
ARRETEZ DE POURRIR LE CODE SOURCE AVEC DU #@! DE BLABLA QUI N'A RIEN A Y FOUTRE.
<aol>Dans mes bras !!!</aol>
$dans_mes_bras++; // on ajoute 1 à $dans_mes_bras
/* * --- JMM 5/3/99 * Correction de l'erreur d'incrémentation de $dans_mes_bras * $dans_mes_bras--; (ancien code) * --- JMM 5/3/99 */ $dans_mes_bras++; // on ajoute 1 à $dans_mes_bras /* * --- JMM 5/3/99 * Fin de la correction * --- JMM 5/3/99 */
Laurent Seguin
Etienne SOBOLE , le 01 oct. 2004 09:04:59, écrivait ceci:
Les commentaires dans le code c'est vital. C'est pour les générations de développeurs qui viendront après sur le projet. On écrit d'abord les commentaires, puis on rempli avec le code.
Interessante position. Cela me semble pourtant, meme si j'aurai tendance a abonder dans ton sens... utopique. La plupart des developpeurs PHP travaillent sur des projets de petite envergure (j'entends par là moins d'une année/homme) Et donc il faut bien reconnaitre que les exigences de temps de developpement empèche complètement ce genre de prétraitement.
Je ne suis pas d'accord. C'est une habitude à prendre c'est tout.
Personellement je commence toujours mon codage par des commentaires qui me servent autant (j'ai voulu faire quoi la déjà ?) que pour le type qui passera apprès (comment ça marche ce machin ?).
Non seulement cela me sert à structurer différement mes idées mais également de pense bête ; puis j'agrémente tout au long du codage de petits commentaires pour expliquer le but de certaines instruction pour gagner du temps à la relecture ou mieux comprendre certaines choses.
Avant je ne documentais que le strict minimum et ne me servait que sur les fonctionalitées à développer qui étaient violemment jeté sur un coin de feuille. Deux ou trois fois je me suis fait dérangé pendant des dev un peu chaud et j'ai passé plus de temps à me relire pour me remettre en tête ce que j'avais écrit et ou je voulais en venir qu'à pisser mon code. Depuis je commente beaucoup plus et je suis dérangeable à tout moment et je gagne du temps lors de la reprise du code quelques mois plus tard :-)
++
Etienne SOBOLE <e.news@webshaker.net>, le 01 oct. 2004 09:04:59,
écrivait ceci:
Les commentaires dans le code c'est vital. C'est pour les générations
de développeurs qui viendront après sur le projet. On écrit d'abord
les commentaires, puis on rempli avec le code.
Interessante position.
Cela me semble pourtant, meme si j'aurai tendance a abonder dans ton
sens... utopique.
La plupart des developpeurs PHP travaillent sur des projets de petite
envergure (j'entends par là moins d'une année/homme)
Et donc il faut bien reconnaitre que les exigences de temps de
developpement empèche complètement ce genre de prétraitement.
Je ne suis pas d'accord. C'est une habitude à prendre c'est tout.
Personellement je commence toujours mon codage par des commentaires qui me
servent autant (j'ai voulu faire quoi la déjà ?) que pour le type qui
passera apprès (comment ça marche ce machin ?).
Non seulement cela me sert à structurer différement mes idées mais
également de pense bête ; puis j'agrémente tout au long du codage de petits
commentaires pour expliquer le but de certaines instruction pour gagner du
temps à la relecture ou mieux comprendre certaines choses.
Avant je ne documentais que le strict minimum et ne me servait que sur les
fonctionalitées à développer qui étaient violemment jeté sur un coin de
feuille. Deux ou trois fois je me suis fait dérangé pendant des dev un peu
chaud et j'ai passé plus de temps à me relire pour me remettre en tête ce
que j'avais écrit et ou je voulais en venir qu'à pisser mon code. Depuis je
commente beaucoup plus et je suis dérangeable à tout moment et je gagne du
temps lors de la reprise du code quelques mois plus tard :-)
Etienne SOBOLE , le 01 oct. 2004 09:04:59, écrivait ceci:
Les commentaires dans le code c'est vital. C'est pour les générations de développeurs qui viendront après sur le projet. On écrit d'abord les commentaires, puis on rempli avec le code.
Interessante position. Cela me semble pourtant, meme si j'aurai tendance a abonder dans ton sens... utopique. La plupart des developpeurs PHP travaillent sur des projets de petite envergure (j'entends par là moins d'une année/homme) Et donc il faut bien reconnaitre que les exigences de temps de developpement empèche complètement ce genre de prétraitement.
Je ne suis pas d'accord. C'est une habitude à prendre c'est tout.
Personellement je commence toujours mon codage par des commentaires qui me servent autant (j'ai voulu faire quoi la déjà ?) que pour le type qui passera apprès (comment ça marche ce machin ?).
Non seulement cela me sert à structurer différement mes idées mais également de pense bête ; puis j'agrémente tout au long du codage de petits commentaires pour expliquer le but de certaines instruction pour gagner du temps à la relecture ou mieux comprendre certaines choses.
Avant je ne documentais que le strict minimum et ne me servait que sur les fonctionalitées à développer qui étaient violemment jeté sur un coin de feuille. Deux ou trois fois je me suis fait dérangé pendant des dev un peu chaud et j'ai passé plus de temps à me relire pour me remettre en tête ce que j'avais écrit et ou je voulais en venir qu'à pisser mon code. Depuis je commente beaucoup plus et je suis dérangeable à tout moment et je gagne du temps lors de la reprise du code quelques mois plus tard :-)
