Programmation web CSS HTML PHP RSS SQL Outils

Modifier la couleur:

Style du site en bleu

Style du site en orange

Style du site en mauve

Style du site en noir

Style du site en rouge

Style du site en vert

Programmation web / PHP / Commentaire

Commentaires dans une page PHP

Voici comment mettre des commentaires dans une page PHP pour ensuite être capable de créé une documentation avec PHPDocumentor :

Pour toutes les pages, il faut ajouter les informations suivantes au début du fichier php :

<?php
/*
*  ici mettre les informations sur le fichier en question à quoi il sert
*
* date créé: 2 février 2008
* date modifier : 20 février 2008
*
* @author Prénom Nom <courriel@php.net>
* @copyright Copyright (c) 2008, PHPascal.com
* @version 1.1
*
*/
?>

Pour une fonction on doit spécifier les paramêtres et les paramêtre envoyer (s'il y en a)
Exemple :
<?php
/*
* Fonction afficher sert à .. (description)
* @param $aaa =  description du paramètre 1
* @param $bbb=  description du paramètre 2
* @param $ccc=  description du paramètre 3 avec paramètre par defaut
* @return $rrr = description de la valeur retourné
*/
function afficher($aaa,$bbb,$ccc=0)
{
    .........................................
    ........................................
    return $rrr;
}
?>



En utilisant ce type de formatage pour construire un site web dynamique en php, ont peux par la suite faire la création d'un documentation de sont site automatiquement avec PHPDocumentor.


Il y a aussi d'autres informations qu'on peux ajouter: voir la liste complète des tags PHPDocumentor

Article écrit le 20 février 2008
Article modifié le 20 février 2008

Autres articles sous la même catégorie

• Trouvé une date dans le passé ou dans le futur avec un fonction PHP
• Installation de notification instantané avec Paypal (IPN, instant payment notification) méthode simple ou compliquer
• Redimentionner une image avec Imagemagik avec un script php
• Ré-écriture des url - 'RewriteRule' - url pour moteur de recherche
• Faire des includes php - inclure des pages en php
• Requête sql en php - Faire une requete sql avec PHP
• Fichier de connexion sql
• Gestion des erreurs en PHP avec une fonction