File "coding-style.html"
Full path: /home/eliteafr/./pmb/doc/coding-style.html
File
size: 10.29 B
MIME-type: text/html
Charset: 8 bit
Download Open Edit Advanced Editor &nnbsp; Back
<!--
+---------------------------------------------------------------------------------------+
2002-2005 PMB Services / www.sigb.net pmb@sigb.net et contributeurs (voir www.sigb.net)
+---------------------------------------------------------------------------------------+
$Id: coding-style.html,v 1.2 2005-05-12 08:06:47 gautier Exp $
AIDE POUR LES DEVELOPPEURS
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="fr">
<head>
<title>
Php coding style
</title>
<link rel="stylesheet" type="text/css" href="default.css">
</head>
<body>
<h1>
Php coding style
</h1>
<p>
Ces quelques règles de base concernant le style de codage dans l'application sont directement issues du PEAR coding-style.
</p>
<h2>
Indentation
</h2>
<p>
Utilisez une indentation de 4 espaces, mais pas de tabulations. Si vous utilisez Emacs pour éditer du code PEAR, pensez à mettre indent-tabs-mode à nil. Voici un exemple de hook qui va configurer Emacs suivant ces conseils (vous devez vous assurer qu'il sera appelé avant l'édition des fichiers PHP) :
</p>
<pre>
(defun php-mode-hook ()
(setq tab-width 4
c-basic-offset 4
c-hanging-comment-ender-p nil
indent-tabs-mode nil))
</pre>
<p>
Voici quelques règles pour vim :
</p>
<pre>
set expandtab
set shiftwidth=4
set tabstop=4
</pre>
<h2>
Structures de contrôle
</h2>
<p>
Cela couvre if, for, while, switch, etc... Voici un exemple de condition if, (c'est une des plus compliquées) :
</p>
<pre>
if ((condition1) || (condition2)) {
action1;
} elseif ((condition3) && (condition4)) {
action2;
} else {
defaultaction;
}
</pre>
<p>
Les structures de contrôle doivent être suivi d'un espace et d'une parenthèse ouvrante, pour les distinguer des appels de fonctions.
</p>
<p>
Il est vivement recommandé d'utiliser les accolades en toutes occasions, même lorsqu'elles sont techniquement optionnelles. Cela améliore nettement la lisibilité, et réduit la probabilité d'erreurs lorsque de nouvelles lignes sont ajoutées.
</p>
<p>
Boucle For, switch :
</p>
<pre>
switch (condition) {
case 1:
action1;
break;
case 2:
action2;
break;
default:
defaultaction;
break;
}
</pre>
<h2>
Appels de fonctions
</h2>
<p>
Les fonctions doivent être appelées sans espaces entre le nom de la fonction, la parenthèse ouvrante et le premier argument; il faut place un espace entre chaque argument et la virgule de séparation, mais pas d'espace entre le dernier argument, la parenthèse fermante et le point-virgule. Voici un exemple :
</p>
<pre>
$var = foo($bar, $baz, $quux);
</pre>
<p>
Comme illustré ci-dessus, il faut un espace autour des signes égal lorsqu'il est utilisé dans une assignation de variable. Dans le cas d'assignation en bloc, plusieurs espaces peuvent être introduit pour améliorer la lisibilité.
</p>
<pre>
<?php
$short = foo($bar);
$long_variable = foo($baz);
?>
</pre>
<h2>
Définitions de fonctions
</h2>
<p>
Les déclarations de fonction suivent la convention "one TRUE brace" (une seule accolade véritable) :
</p>
<pre>
<?php
function fooFunction($arg1, $arg2 = '')
{
if (condition) {
statement;
}
return $val;
}
?>
</pre>
<p>
Les arguments ayant une valeur par défaut doivent aller à la fin de la liste des arguments. Essayez de retourner une valeur utile de vos fonctions, dès que c'est le cas. Voici un exemple :
</p>
<pre>
<?php
function connect(&$dsn, $persistent = FALSE)
{
if (is_array($dsn)) {
$dsninfo = &$dsn;
} else {
$dsninfo = DB::parseDSN($dsn);
}
if (!$dsninfo || !$dsninfo['phptype']) {
return $this->raiseError();
}
return TRUE;
}
?>
</pre>
<h2>
Commentaires
</h2>
<p>
La documentation du code doit suivre les conventions de PHPDoc, similaire à Javadoc. Plus d'informations sur PHPDoc sont disponibles ici : <a href="http://www.phpdoc.de/">http://www.phpdoc.de/</a>.
</p>
<p>
Les commentaires hors documentation sont vivement conseillés. En règle généaral, si vous voyez une portion de code et que vous pensez "Houla!, je n'ai pas envie de tester ça", vous devez la commentez avant d'oublier ce qu'elle fait.
</p>
<p>
Les commentaires de style C (/* */) et standard C++ (// ) sont bien tous les deux. Les autres styles (notamment Perl et shell (# )) sont déconseillés.
</p>
<h2>
Inclusion de code
</h2>
<p>
A chaque fois que vous incluez inconditionnellement une classe, utilisez la fonction require_once(). A chaque fois que vous incluez conditionnellement une classe, utilisez la fonction include_once(). Ces deux fonctions s'assureront que les classes ne sont déclarées qu'une seule fois. Elles partagent la même liste de fichier, ce qui permet leur utilisation sans gêne. Un fichier inclus par require_once() ne sera pas inclus encore une fois avec include_once().
</p>
<p>
<u>Note</u> : include_once() et require_once() sont des commandes, et pas des fonctions. Vous n'êtes pas obligés d'utiliser des parenthèses autour des noms de fichiers.
</p>
<p class="important">
Important. Il ne faut pas inclure de fichiers externes dans les fichiers de définition de classes. Cela rend plus complexe la réutilisation du code et nous avons donc banni ce procédé
</p>
<h2>
Balises de code PHP
</h2>
<p>
Utilisez toujours la syntaxe <?php ?> pour délimiter du code PHP, et jamais <? ?>
. Ceci est nécessaire pour la compatibilité du code PEAR et c'est la version la plus portable du code PHP sur les différents systèmes d'exploitation.
</p>
<h2>
Entête de fichier
</h2>
<p>
Tous les codes sources des distributions PEAR doivent contenir les commentaires suivants comme entête :
</p>
<pre>
/* vim: set expandtab tabstop=4 shiftwidth=4: */
// +----------------------------------------------------------------------+
// | PHP version 4.0 |
// +----------------------------------------------------------------------+
// | Copyright (c) 1997, 1998, 1999, 2000, 2001 The PHP Group |
// +----------------------------------------------------------------------+
// | This source file is subject to version 2.0 of the PHP license, |
// | that is bundled with this package in the file LICENSE, and is |
// | available at through the world-wide-web at |
// | http://www.php.net/license/2_02.txt. |
// | If you did not receive a copy of the PHP license and are unable to |
// | obtain it through the world-wide-web, please send a note to |
// | license@php.net so we can mail you a copy immediately. |
// +----------------------------------------------------------------------+
// | Authors: Original Author <author@example.com> |
// | Your Name <you@example.com> |
// +----------------------------------------------------------------------+
//
// $Id: coding-style.html,v 1.2 2005-05-12 08:06:47 gautier Exp $
</pre>
<p>
Il n'y a pas de règle fixe pour déterminer à quel moment un contributeur doit être ajouté dans la liste des auteurs d'un fichier source. En général, les modifications doivent être substancielle (environs 10 à 20% du code initial). Des dérogations peuvent être données pour les réécritures complètes de fonctions, ou les contributions à de nouvelles logiques d'utilisation.
</p>
<p>
La simple réorganisation de code ou les corrections de bug ne justifie pas l'ajout d'un contributeur dans la liste des auteurs.
</p>
<p>
Les fichiers qui ne font pas partie de la bibliothèque de base PEAR doivent avoir un bloc comparable à celui cité ci-dessus, indiquant le copyright, la licence et les auteurs. Tous les fichiers devraient inclure une description du modèle suivi, pour améliorer la cohérence de l'ensemble.
</p>
<h2>
Balises CVS
</h2>
<p>
Ajoutez le signe $Id: coding-style.html,v 1.2 2005-05-12 08:06:47 gautier Exp $ (CVS vendor tag) dans chaque fichier. Dans chaque fichier que vous éditez, pensez à l'ajouter s'il n'est pas présent (ou remplacez les anciennes valeurs telles que "Last Modified:", etc.).
</p>
<p>
<u>Note</u> : Nous avons une marque $Horde dans le CVS Horde pour suivre nos versions séparément. Nous pouvons faire la même chose avec une marque $PEAR, qui resterait même si les fichiers PEAR migrent sur un autre système de suivi de version.
</p>
<h2>
URL d'exemple
</h2>
<p>
Utilisez "example.com" pour tous les exemples, comme spécifié dans la RFC 2606
</p>
<h2>
Noms des constantes
</h2>
<p>
Les constantes doivent toujours être en majuscule, les mots étant séparés par des soulignés (_). Préfixez les constantes avec le nom de la classe ou du package dont elles font parties. Par exemple, les constantes utilisées dans le package DB:: commencent toutes par "DB_".
</p>
</body>
</html>