© Quesaco. Dernier ajout : 11 mai 2005.
Qu'importe le flacon, pourvu qu'on est l'ivresse. Alfred de Musset
Fonctions PHP d’éditions pour la documentation des librairies de fonctions, à -la-javadoc, ou comment commenter proprement ses fonctions et les classer dans sa librairie personnelle. Approche du sujet...
DOC. Pour vous aider à rédiger la documentation technique de votre code "source" PHP.
Edition "à la javadoc" de la documentation technique de vos fonctions PHP. Sa mise en place est très simple, bien que contraignante. Pour un bon résultat, il faut une fonction par fichier, mais ce n’est pas une obligation.
Pour plus de précision sur le format javadoc, on pourra lire http://java.sun.com/products/jdk/1.2/docs/tooldocs/win32/javadoc.html
Les fonctions DOC permettent de :
Lire les commentaires présents au format javadoc (doc_comment). Afficher les commentaires acquis sous forme de tableau, cette page elle-même en est un exemple.
Distribution complète à télécharger au 11 mai 2005 :
Ce "package" n’est pas mis à jour automatiquement, le numéro de version et la date pour chaque fonction documentée vous aidera à vérifier ce point.
Conseil : définir la constante FOLDER (dossier où vous placez ces fichiers) avant appel.