Bonnes pratiques PHP : documentez votre code

Magazine
Marque
GNU/Linux Magazine
Numéro
158
Mois de parution
mars 2013
Spécialité(s)


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.
S'abonner à Connect
  • Accédez à tous les contenus de Connect en illimité
  • Découvrez des listes de lecture et des contenus Premium
  • Consultez les nouveaux articles en avant-première
Je m'abonne


Article rédigé par

Par le(s) même(s) auteur(s)

Joplin, un logiciel de gestion de notes tout-terrain

Magazine
Marque
Linux Pratique
Numéro
142
Mois de parution
mars 2024
Spécialité(s)
Résumé

Il existe de nombreux logiciels pour prendre, organiser et partager ses notes. Vous en avez sans doute déjà essayé quelques-uns. Moi aussi. Alors, peut-être que Joplin ne vous conviendra pas, personne ne peut plaire à tout le monde. Mais vous devriez quand même y jeter un coup d’œil, car Joplin n’est pas seulement un logiciel. C’est le cœur d’un écosystème autour duquel gravitent bon nombre d’applications complémentaires.

FrankenPHP : vers une nouvelle génération de serveurs PHP ?

Magazine
Marque
GNU/Linux Magazine
Numéro
268
Mois de parution
mars 2024
Spécialité(s)
Résumé

C'est bien connu, PHP est lent. Si au fil des versions, il a fait énormément de progrès, son principe de fonctionnement originel, celui d'un langage interprété nécessitant la relecture de tous les fichiers impliqués à chaque requête, pose une limite indépassable. Vraiment ? Et si le serveur conservait toute l'application en mémoire à tout moment ? Voilà ce que vous propose FrankenPHP.

Borg Backup, la sauvegarde facile, économique et efficace

Magazine
Marque
Linux Pratique
Numéro
142
Mois de parution
mars 2024
Spécialité(s)
Résumé

Retour aux fondamentaux : aucun système d'information n'a plus de valeur que sa sauvegarde ! Malgré cela, cet aspect est souvent négligé, tant on n'en ressent pas l'absence jusqu'au jour où elle se faire cruellement sentir. Mais ce jour-là, il est trop tard. Voyons comment prévenir le pire avec Borg Backup, et son outil compagnon Borgmatic.

Les derniers articles Premiums

Les derniers articles Premium

Générez votre serveur JEE sur-mesure avec Wildfly Glow

Magazine
Marque
Contenu Premium
Spécialité(s)
Résumé

Et, si, en une ligne de commandes, on pouvait reconstruire son serveur JEE pour qu’il soit configuré, sur mesure, pour les besoins des applications qu’il embarque ? Et si on pouvait aller encore plus loin, en distribuant l’ensemble, assemblé sous la forme d’un jar exécutable ? Et si on pouvait même déployer le tout, automatiquement, sur OpenShift ? Grâce à Wildfly Glow [1], c’est possible ! Tout du moins, pour le serveur JEE open source Wildfly [2]. Démonstration dans cet article.

Bénéficiez de statistiques de fréquentations web légères et respectueuses avec Plausible Analytics

Magazine
Marque
Contenu Premium
Spécialité(s)
Résumé

Pour être visible sur le Web, un site est indispensable, cela va de soi. Mais il est impossible d’en évaluer le succès, ni celui de ses améliorations, sans établir de statistiques de fréquentation : combien de visiteurs ? Combien de pages consultées ? Quel temps passé ? Comment savoir si le nouveau design plaît réellement ? Autant de questions auxquelles Plausible se propose de répondre.

Les listes de lecture

9 article(s) - ajoutée le 01/07/2020
Vous désirez apprendre le langage Python, mais ne savez pas trop par où commencer ? Cette liste de lecture vous permettra de faire vos premiers pas en découvrant l'écosystème de Python et en écrivant de petits scripts.
11 article(s) - ajoutée le 01/07/2020
La base de tout programme effectuant une tâche un tant soit peu complexe est un algorithme, une méthode permettant de manipuler des données pour obtenir un résultat attendu. Dans cette liste, vous pourrez découvrir quelques spécimens d'algorithmes.
10 article(s) - ajoutée le 01/07/2020
À quoi bon se targuer de posséder des pétaoctets de données si l'on est incapable d'analyser ces dernières ? Cette liste vous aidera à "faire parler" vos données.
Voir les 64 listes de lecture

Abonnez-vous maintenant

et profitez de tous les contenus en illimité

Je découvre les offres

Déjà abonné ? Connectez-vous