Les règles de codage de PEAR incluent des règles d'indentation, des structures de contrôle, des appels de fonctions, des définitions de fonctions, des commentaires, du code inclus, des balises PHP, des blocs de commentaires dans les en-têtes de fichiers, des balises CVS, des exemples d'URL et la dénomination des constantes. Voici une brève introduction
apt-get install php-pear
pear install channel://pear.php.net/PHP_ArrayOf-0.2.1
canal de téléchargement pear://pear.php.net/PHP_ArrayOf-0.2.1
Règles de codage PEEAR
Les règles de codage PEAR incluent des règles d'indentation et des structures de contrôle, des appels de fonction , définitions de fonctions, commentaires, 11 aspects dont le code, les balises PHP, les blocs de commentaires dans les en-têtes de fichiers, les balises CVS, les échantillons d'URL et la dénomination des constantes. Voici une brève introduction :
Règles d'indentation :
PEAR nécessite 4 espaces pour indenter le code, et aucune TAB n'est utilisée. Si vous utilisez VIM, mettez les paramètres suivants dans votre ~/.vimrc :
set expandtabset shiftwidth=4set tabstop=4
Si vous utilisez Emacs/XEmacs, requis Set indent -tabs-mode à zéro.
Mais si vous aimez utiliser (X)Emacs pour éditer des fichiers PHP comme moi, je vous recommande fortement d'installer PHP-MODE afin que lorsque vous écrivez du code PEAR, il ajuste automatiquement votre style d'indentation. Bien sûr. PHP-MODE possède également de nombreuses excellentes fonctionnalités. Vous pouvez télécharger la dernière version de PHP-MODE à partir de la liste des ressources.
Structure de contrôle :
Les structures de contrôle mentionnées ici incluent : if for while switch, etc. Pour les structures de contrôle, il doit y avoir un espace après le mot-clé (comme if for ..), puis les parenthèses de contrôle, afin qu'il ne soit pas confondu avec les appels de fonction. De plus, vous devez essayer d'utiliser des accolades {}. aussi complètement que possible, même si c'est syntaxiquement facultatif. Cela évitera toute confusion logique ou erreur lorsque vous devrez ajouter de nouvelles lignes de code à l'avenir. Voici un exemple : 3;}
Fonction :
Pour les appels de fonction, les noms de fonction et les crochets gauches (il ne doit y avoir aucun espace entre la fonction, pour le paramètre de fonction, le virgule et le paramètre suivant des paramètres séparés et suivants Il doit y avoir la même séparation d'espace entre eux, et il ne doit y avoir aucun espace entre le dernier paramètre et le crochet droit. Ce qui suit est un appel de fonction standard. Il doit y avoir des espaces entre eux. les variables assignées. En même temps, s'il s'agit d'une série d'instructions d'affectation liées, vous ajoutez des espaces appropriés pour les aligner, comme ceci :
$result = foo($param1, $param2, $param3); 不规范的写法: $result=foo ($param1,$param2,$param3);$result=foo( $param1,$param2, $param3 );
$result1 = $foo($param1, $param2, $param3); $var2 = $foo($param3); $var3 = $foo($param4, $param5);
À propos des commentaires :
Pour la documentation en ligne des classes, elle doit être convertie par PHPDoc, tout comme JavaDoc est également une application PEAR. Pour une introduction plus détaillée, vous pouvez aller sur http://www.phpdoc.de/ View. documentation en ligne pour les cours, il est recommandé d'utiliser des commentaires non liés à la documentation pour expliquer votre code. Lorsque vous voyez un morceau de code, vous pensez : Oh, je ne pense pas que ce soit obligatoire. décrit soigneusement dans la documentation. Ensuite, vous feriez mieux de faire un simple commentaire pour ce code pour éviter d'oublier comment il fonctionne, /* */ pour C et / pour C++ / sont très bien, mais ne le faites pas. n'utilisez pas le style de commentaire # de Perl ou du shell.
Inclure le code : Utilisez require_once ; lorsque vous devez inclure conditionnellement un fichier de classe, vous devez utiliser include_once, cela garantit que le fichier que vous souhaitez inclure ne sera inclus ; once, et ces deux instructions partagent la même liste de fichiers, vous n'avez donc pas à vous soucier de la confusion entre les deux, une fois que require_once inclut un fichier, include_once n'inclura plus le même fichier, et vice versa. 🎜>Balise de code PHP : ?> Définissez votre code PHP au lieu de simplement utiliser Cela peut garantir la compatibilité de PEAR et également faciliter le portage multiplateforme.
Instruction de commentaire dans l'en-tête du fichier :
Pour tous les fichiers de code PHP qui doivent être inclus dans la version principale de PEAR, vous devez ajouter l'instruction de commentaire suivante au début de la déposer:
/* 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 | // | Your Name | // +----------------------------------------------------------------------+ // // $Id$
对于不在PEAR核心代码库中的文件,建议你也在文件的开始处有这样一个类似的注释块,标明版权,协议,作者等等。同时也在第一行加入VIM的MODELINE,这样在VIM中能够保持PEAR的代码风格。
CVS标记:
如上面所展示那样,在每个文件中加入CVS的ID标记,如果你编辑或修改的文件中没有这个标记,那么请加入,或者是替换原文件中相类似的表现形式(如"Last modified"等等)
URL样本:
你可以参照RFC 2606,使用"www.example.com"作为所有的URL样本。
常量命名:
常量应该尽量使用大写,为了便于理解,使用下划线分割每个单词。同时,你应该常量所在的包名或者是类名作为前缀。比如,对于Bug类中常量应该以Bug_开始。
以上是PEAR的编码规则,详细的编码规则可以参考PEAR中的CODING_STANDDARD文件的说明。为了更好地理解这些编码规则,你也可以参考一下现有PEAR核心模块的代码。
推荐学习:php视频教程
Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!