Programmation web CSS HTML PHP Javascript RSS SQL SSH, serveur linux Outils
  PHPascal a 95 articles


Recherche

Modifier la couleur:

• Bleu
• Orange
• Mauve
• Noir
• Rouge
• 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

• Calculer l'age d'une personne avec requete SQL et PHP
• Fonction php pour trouver l'extention d'un fichier
• Fonction pour formater une date en français en PHP.
• Fonction pour convertir du texte en URL (enleve les caractère spéciaux et les accents)
• Trouver la latitude et longitude a partir d'une adresse via l'API de Google Map
• Script pour forcé le téléchargement d'un fichier
• Création d'un mot de passe aléatoire en PHP, génération automatique de mots de passe
• PHP - fonction pour vérifier si une image distante existe (avec l'URL)
• Script php pour parcourir les fichiers d'un répertoire de façon récursive
• Ajouter l'option wisiwig au logiciel phpMyNewsletter avec KFCEditor
• Protection contre les robots qui remplisse les formuaires en PHP
• Afficher en php les tables d'une base de données
• Envoyer un courriel la façon simple avec PHP
• 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 - (avec .htaccess)
• Gestion des erreurs en PHP avec une fonction
• Fichier de connexion sql
• Requête sql en php - Faire une requete sql avec PHP
• Faire des includes php - inclure des pages en php