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)

Surveillez un dossier de sources pour exécuter une commande automatiquement

Magazine
Marque
GNU/Linux Magazine
Numéro
206
Mois de parution
juillet 2017
Spécialité(s)
Résumé
Lorsque l'on développe avec certains outils, un site web avec Jekyll par exemple, on vous propose une option qui se révèle bien pratique, souvent appelée --watch. Lorsqu'elle est activée, l'outil surveille le dossier contenant votre code source pour le recompiler dès qu'une modification intervient. Mais lorsque le processus de compilation fait intervenir plus d'un outil, ou si celui qui a votre préférence ne vous offre justement pas cette option, il paraît difficile de continuer à fonctionner comme cela. La solution : inotifywait !

Les derniers articles Premiums

Les derniers articles Premium

Donnez une autre dimension à vos logs avec Vector

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

Avoir des informations précises et détaillées sur ce qu’il se passe dans une infrastructure, et sur les applications qu'elle héberge est un enjeu critique pour votre business. Cependant, ça demande du temps, temps qu'on préfère parfois se réserver pour d'autres tâches jugées plus prioritaires. Mais qu'un système plante, qu'une application perde les pédales ou qu'une faille de sécurité soit découverte et c'est la panique à bord ! Alors je vous le demande, qui voudrait rester aveugle quand l'observabilité a tout à vous offrir ?

Du graphisme dans un terminal ? Oui, avec sixel

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

On le voit de plus en plus, les outils en ligne de commandes s'étoffent peu à peu d'éléments graphiques sous la forme d'émojis UTF8. Plus qu'une simple décoration, cette pointe de « graphisme » dans un monde de texte apporte réellement un plus en termes d'expérience utilisateur et véhicule, de façon condensée, des informations utiles. Pour autant, cette façon de sortir du cadre purement textuel d'un terminal n'est en rien une nouveauté. Pour preuve, fin des années 80 DEC introduisait le VT340 supportant des graphismes en couleurs, et cette compatibilité existe toujours...

Game & Watch : utilisons judicieusement la mémoire

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

Au terme de l'article précédent [1] concernant la transformation de la console Nintendo Game & Watch en plateforme de développement, nous nous sommes heurtés à un problème : les 128 Ko de flash intégrés au microcontrôleur STM32 sont une ressource précieuse, car en quantité réduite. Mais heureusement pour nous, le STM32H7B0 dispose d'une mémoire vive de taille conséquente (~ 1,2 Mo) et se trouve être connecté à une flash externe QSPI offrant autant d'espace. Pour pouvoir développer des codes plus étoffés, nous devons apprendre à utiliser ces deux ressources.

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 53 listes de lecture

Abonnez-vous maintenant

et profitez de tous les contenus en illimité

Je découvre les offres

Déjà abonné ? Connectez-vous