Accueil

Astuces

Flash

Librairie

Outils

Liens

Etudes

Sécurité

Sources

Contact

PHP Lib DOC

Il y a des moments où tout réussit. Il ne faut pas s'effrayer : ça passe.Jules Renard (Journal)

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 : kzo_doc_20050511.zip . 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.

kzo_doc

kzo_doc() Définitions globales pour la librairie kzo_doc

@author Christian Paulus

@version 1.0, 05/15/2002

@see kzo_doc_get

@see kzo_get_dump

@since PHP3

kzo_doc_dump

kzo_doc_dump() affiche en forme de tableau le résultat obtenu par kzo_doc_get()

@author Christian Paulus

@version 1.0, 05/15/2002

@version 1.01, 05/17/2002

@version 1.02, 09/06/2002

@param $comments: Array doc_comment format.

@param $rtf: Print in RTF format (default: TRUE)

@param $folder: Add link to download package if available in this folder

@see kzo_doc_get

@since PHP3

kzo_doc_get_title

kzo_doc_get_title() extract 'title' data from html page

@author Christian Paulus

@version 1.0, 06/09/2002

@param $file Target file (html page)

@return result

@since PHP3

kzo_doc_get

kzo_doc_get() lit le fichier désigné et recherche les descriptions présentes au format doc_comment. Pour plus de précision sur ce format, lire http://java.sun.com/products/jdk/1.2/docs/tooldocs/win32/javadoc.html

@author Christian Paulus

@version 1.0, 05/15/2002

@version 1.01, 09/04/2004

@version 1.02, 06/05/2004

@param $file Target file to read

@param $result result container

@param $free Flag: TRUE to free $result before act, FALSE to append new result to $result

@see kzo_doc_dump

@return TRUE if doc_comment found. FALSE otherwise

@since PHP3

kzo_doc_dumpcss

kzo_doc_dumpcss() affiche en forme CSS le résultat obtenu par kzo_doc_get()