tailieunhanh - Pratique de MySQL et PHP- P48

Pratique de MySQL et PHP- P48:Quand la première édition de ce livre est parue, en janvier 2001, la réputation de MySQL et de PHP était déjà bien établie. Ces deux outils étaient connus pour être fiables, performants, pratiques et bien adaptés à une utilisation très spécialisée : la production dynamique de pages HTML. | Choix des outils Production d une documentation avec PhpDoc La communauté des développeurs PHP a produit de nombreux outils pour constituer des environnements logiciels de qualité. Ces outils contribuent à faire de PHP un concurrent tout à fait présentable de langages anciens et éprouvés comme C ou Java. La possibilité de produire une documentation directement à partir du code fait partie de ces acquis. Dans le monde PHP l outil qui semble le plus utilisé est PhpDocumentor http et c est donc celui que je présente ensuite. Cela étant des logiciels plus généralistes comme doxygen qui s applique également au C au C à Java et à beaucoup d autres langages produisent également un très beau travail. Documenter du PHP pour PhpDoc PhpDoc produit un site HTML statique contenant une description technique extraites des fichiers PHP d une application web. La figure montre un exemple d une page PhpDoc produite automatiquement pour le site WEBSCOPE. MJflWlÿiSjL fhp HD5Ç4. cnrlKl pf-il Figure Exemple de page produite par PhpDoc Fer 0141 HOU SOL WSüoeSGBD La documentation est basée sur la notion de DocBlock qui sert à documenter des éléments du code. Les éléments sont les fonctions les variables les classes et tous les composants logiciels d une application PHP. Chaque DocBlock est simplement un commentaire de la forme . notez les deux étoiles initiales constitué de trois parties aparaissant dans l ordre suivant 1. une description courte 2. une description longue 214 Chapitre 5. Organisation du développement 3. des balises choisies parmi un ensemble pré-défini et décrivant un des aspects de l élément documenté par exemple la balise author indique l auteur de l élément . La stratégie utilisée pour la documentation varie selon le type d élément documenté. Pour faire simple limitons-nous ici au cas des classes PHP orientées-objet. On peut les documenter à deux niveaux la classe et la méthode on pourrait envisager trois niveaux si on mettait plusieurs .