Bonnes pratiques PHP : documentez votre code

Magazine
Marque
GNU/Linux Magazine
Numéro
158
Mois de parution
mars 2013
Domaines


Résumé
Une des bonnes habitudes à prendre lorsque l'on programme est de documenter son code, mais encore faut-il le faire bien. Pour cela, PHPDoc est un outil de choix.

Directement inspiré de Javadoc, PHPDoc vous propose d'intégrer votre documentation directement dans votre code sous la forme de commentaires à la syntaxe normalisée. La bonne habitude à prendre est d'écrire ces commentaires en même temps que votre code, limitant l'augmentation de la charge de travail liée à la production de cette documentation.

Arrivé cette année dans sa version 2, qui supporte PHP 5.3 et ultérieurs, phpDocumentor est l'un des outils de génération de documentation s'appuyant sur PHPDoc, et c'est celui avec lequel nous allons travailler ici, en nous appuyant sur son implémentation de PHPDoc, mais rien ne vous empêche de lui préférer Doxygen.

Cerise sur le gâteau : si vous utilisez un bon IDE pour saisir votre code, celui-ci sera capable de s'appuyer également sur PHPDoc pour vous assister plus efficacement.

Un bémol toutefois : la documentation automatique est destinée aux développeurs de l'application et certainement pas à ses utilisateurs....

Cet article est réservé aux abonnés. Il vous reste 93% à découvrir.
à partir de 21,65€ HT/mois/lecteur pour un accès 5 lecteurs à toute la plateforme
J'en profite


Articles qui pourraient vous intéresser...

Utiliser Visual Studio Code pour coder en Python

Magazine
Marque
GNU/Linux Magazine
Numéro
243
Mois de parution
décembre 2020
Domaines
Résumé

Comme Batman a Robin, Rocket Raccoon a Groot, le développeur a l’éditeur de code. Sans son plus fidèle acolyte, impossible d’écrire la moindre ligne de code... d’où l’importance d’être toujours à la recherche de l’outil le plus efficace qui soit, quitte à délaisser un vieux compagnon de route...

Générez la documentation technique de vos projets Godot

Magazine
Marque
GNU/Linux Magazine
Numéro
243
Mois de parution
décembre 2020
Domaines
Résumé

Découvrons comment utiliser GDScript Docs Maker pour générer automatiquement la documentation de vos projets Godot. Nous allons voir dans cet article que l’on peut simplement, à partir de notre code et de ses commentaires, avoir une documentation toujours à jour.

Implémentation du calcul symbolique et de la dérivation en Java

Magazine
Marque
GNU/Linux Magazine
Numéro
243
Mois de parution
décembre 2020
Domaines
Résumé

Les logiciels de calcul symbolique sont relativement abondants. Pour les curieux ou ceux qui voudraient intégrer ce type de fonctionnalités dans leurs propres programmes, nous allons essayer de lever une partie des mystères des théories et des problèmes qui se cachent derrière la création de ces systèmes.

Déboguez vos codes PHP

Magazine
Marque
GNU/Linux Magazine
Numéro
243
Mois de parution
décembre 2020
Domaines
Résumé

La mise au point de programmes PHP est parfois perçue comme archaïque, car la configuration d’un environnement efficace de debugging peut s’avérer déroutante. Voici comment paramétrer une confortable installation pour profiter pleinement d’outils professionnels et maîtriser le développement local ou distant.