Logo GNT
Actualités Tests & Guides Bons Plans
GTA 6 iPhone 17 Copilot Switch 2 Temu ChatGPT Tesla
OVH Cloud OVH Cloud
Entraide Développement Développement Langage PHP Outils pour documenter son code

Outils pour documenter son code

4 réponses
Avatar
Zouplaz
Bonjour, par le passé j'ai utilisé doxygen pour documenter des sources en
C++ et javadoc pour Java.

J'ai cherché parmis les solutions spécifiques à PHP et il me semble que
phpDocumentor est le mieux placé. Il fonctionne correctement mais le manuel
est vraiment mal foutu (sur le comportement de l'outil, pas sur la
description des tags).

Je me demande tout de même s'il y a "mieux". Quels softs utilisez-vous ?

Merci de me donner votre avis...


PS : sur les sources C++ doxygen autorisait cette syntaxe (en pseudo code)

maclasse
{
mavar /// Doc de la variable membre
}

Ce qui est vraiment appréciable.
phpDocumentor ne le permet pas (et ne le permettra pas pour des raisons de
parsing d'après ce que j'ai lu sur leur forum). J'apprécierais de trouver
un outil qui permette ce genre de chose (au lieu de placer la doc de la
variable membre quelques lignes au dessus)
Signaler un problème avec ce contenu

4 réponses

Supprimer
Cette action est irreversible, confirmez la suppression du commentaire ?
Signaler le commentaire

Veuillez sélectionner un problème

Nudité
Violence
Harcèlement
Fraude
Vente illégale
Discours haineux
Terrorisme
Autre
Avatar
ftc
Bonjour, par le passé j'ai utilisé doxygen pour documenter des sources en
C++ et javadoc pour Java.

J'ai cherché parmis les solutions spécifiques à PHP et il me semble que
phpDocumentor est le mieux placé. Il fonctionne correctement mais le manuel
est vraiment mal foutu (sur le comportement de l'outil, pas sur la
description des tags).

Je me demande tout de même s'il y a "mieux". Quels softs utilisez-vous ?



Doxygen permet de travailler sur du PHP il me semble.

Avatar
Zouplaz
ftc wrote in news:432aa063$0$6547$:


Doxygen permet de travailler sur du PHP il me semble.



Disons que la phrase d'intro de doxygen m'a un peu refroidi :
"Doxygen is a documentation system for C++, C, Java, Objective-C, Python,
IDL (Corba and Microsoft flavors) and to some extent PHP, C#, and D."

J'aimerais bien savoir ce qu'ils entendent par "and to some extent"...

Quelqu'un a testé ?

Avatar
Paul
Ici il y à un comparatif en français sur les outils de génération de Doc
pour PHP :
http://cyberzoide.developpez.com/php4/phpdoc/
Avatar
Jean-Marc Molina
Zouplaz a écrit/wrote :
Disons que la phrase d'intro de doxygen m'a un peu refroidi :
"Doxygen is a documentation system for C++, C, Java, Objective-C,
Python, IDL (Corba and Microsoft flavors) and to some extent PHP, C#,
and D."

J'aimerais bien savoir ce qu'ils entendent par "and to some extent"...


En fait Doxygen ne parse pas vraiment du code PHP pour générer la doc, le
code PHP est d'abord traduit en une bouillie compréhensible par le moteur de
Doxygen, une sorte de langage intermédiaire. Par contre je n'ai pas trop
testé Doxygen pour du code PHP 5 donc à voir...

Sinon avis aux développeurs Eclipse j'utilise l'excellent plugin Eclox
(http://home.gna.org/eclox) pour générer mes docs, très très pratique.

--
Jean-Marc.