Partager quelques exemples standards de PHP

Cet article partage principalement avec vous quelques exemples standards de PHP. J'espère que cela aide tout le monde. Lors de la formulation des spécifications, veuillez noter : En règle générale, il ne devrait y avoir aucune situation dans laquelle les deux sont acceptables. Par exemple, les tabulations et les 4 espaces fonctionneront, mais le résultat sera un code déroutant.

Principes généraux :
1. Sémantique
Quand vous voyez le nom, vous connaissez la signification.

2. Le préfixe commun
signifie si, get signifie lire et set signifie écrire. is est d'abord suivi d'adjectifs plutôt que de noms. Par exemple, si le texte est multilingue, is_multilingual doit être utilisé à la place de is_multilingual.

3. Singulier et pluriel
Reportez-vous aux règles de dénomination des fonctions de js : getElementById, getElementsByTagName, getElementsByName.
Par exemple :
Pour obtenir les noms de plusieurs de mes amis, vous devez utiliser getFriendsName au lieu de getFriendNames ou getFriendName
Pour obtenir un utilisateur, getUser
Pour obtenir plusieurs utilisateurs, getUsers

4. Suffixes redondants
Essayez de ne pas utiliser de suffixes de données, de listes et d'informations, sauf circonstances particulières.
Par exemple, faites attention au nommage de js, utilisez getElementsByTagName au lieu de getElementsInfoByTagName.
Vous devez utiliser getFriends ou getFriendsUserId au lieu de getFriendsList ; vous devez utiliser getUser au lieu de getUserInfo ou getUserData.
Mais parfois, il est difficile de l'éviter. Par exemple, il existe deux fonctions, l'une consiste à obtenir les informations de base de l'utilisateur et l'autre est d'obtenir les informations détaillées de l'utilisateur.
Obtenir des informations utilisateur de base : pseudo, URI de l'avatar, nom de la fonction getUserBasic ou getUserBasicInfo ? Les noms de fonctions se terminant par des adjectifs semblent inappropriés. A discuter. Résultat de la discussion : getUserBasicInfo convient.
Obtenir les détails de l'utilisateur : pseudo, URI de l'avatar, signature, anniversaire, nom de la fonction getUser ne pose aucun problème.

5. Noms de classe, noms de fichiers et noms de répertoires ambigus
Soyez prudent chaque fois que vous utilisez commun, util, fonctions, classe, objet, basique comme noms de fichiers, car ces mots sont trop courants et développement Au fur et à mesure que vous descendez, il se peut qu'il y ait de plus en plus de choses à l'intérieur, ce qui la transforme en poubelle. Donnez-leur un nom précis. Par exemple, une classe qui effectue le traitement des chaînes peut être appelée StringLib.php et placée dans le répertoire lib.

6. La différence entre lib, plugin et addon
Certaines classes et fonctions sont comptées comme lib, plugin ou addon. A discuter. Résultats de la discussion : la fonction d'amélioration actuelle est Lib, et les plugins et addons seront examinés plus tard.

7. Vocabulaire couramment utilisé
Utilisez d'abord l'URI, pas l'URL. En raison de plus de rigueur, les nouveaux noms ont commencé à utiliser l'URI. Par exemple, encodeURI de js, $_SERVER['REQUEST_URI'] de PHP.
Dateline et TTL : la date limite représente le dernier moment, et TTL représente le temps de survie. Par exemple, si l'heure actuelle est 1310449710 et que la durée de vie est de 60 secondes, la date limite est 1310449710 + 60 = 1310449770.

Nom de la classe :
Commencez par une lettre majuscule et utilisez un étui camel. Utilisez généralement des noms, tels que la classe d'analyse de configuration ConfigParser au lieu de ParseConfig.
Identique à Java et C++.
Par exemple : class UserModel

Le nom de fichier de la classe :
est le même que le nom de la classe. Ceci est lié au chargement automatique de PHP. Pour effectuer un chargement automatique, le nom de la classe doit toujours être très long. A discuter. Résultat de la discussion : le chargement automatique des classes peut également être obtenu en respectant le cas Camel.
Conforme à Java.
Par exemple : le nom de fichier de la classe UserModel est UserModel.php

Nom de fichier non-classe :
Tout en minuscules, séparés par des traits de soulignement, aucun espace autorisé. Par exemple get_user.php.

Nom du répertoire :
Tout en minuscules, séparés par des traits de soulignement, aucun espace autorisé. Tel que le modèle, www.

Nom de la fonction :
Commencez par une lettre minuscule et soyez nommé en casse chameau, par exemple : function addBlog().
Identique à Java et C++.
Function représente une fonction, c'est-à-dire une action, donc le verbe est prioritaire. Par exemple, utilisez editBlog au lieu de blogEdit.
Pour des raisons historiques, les fonctions intégrées de PHP ont de nombreux styles, tels que do_something, Something_do, dosomething. Les fonctions les plus récentes utilisent doSomething pour être cohérentes avec les langages traditionnels actuels.
Par exemple : paser_str, json_encode, substr, fetchAll.
Les raisons historiques ne peuvent pas être modifiées, mais nous pouvons garantir que le nouveau code est rigoureux et ne nous laisse pas devenir des raisons historiques.

Fonction dans la classe :
Il y a une ligne vide entre les deux fonctions. Si vous avez le temps, triez les fonctions par ordre alphabétique pour éviter toute confusion.
Par exemple :

class BlogModel
{
    public function addBlog()
    {

    }
    
    public function updateBlog()
    {

    }
}

Commentaire de fichier :
Le commentaire suit immédiatement la ligne suivante de Le format suit les exigences de PHPdoc : http://manual.phpdoc.org/HTMLframesConverter/default/phpDocumentor/tutorial_tags.author.pkg.html

<?php
/**
 * blog的各种业务：添加、更新
 * @author sink
 *
 */
class BlogModel
{

}
?>

API notes :
Assurez-vous d'écrire les paramètres d'entrée et le format de sortie. Écrivez clairement ce qui est affiché lorsqu'il est correct et ce qui est affiché lorsqu'il est erroné.
Sinon, d'autres ne peuvent pas l'utiliser.

Commentaires de fonction :
Assurez-vous d'écrire le format de sortie. Écrivez clairement ce qui est affiché lorsqu'il est correct et ce qui est affiché lorsqu'il est erroné.
Si les paramètres d'entrée sont complexes et contiennent des tableaux, et que les paramètres ne peuvent pas être clairement compris en un coup d'œil, vous devez écrire des commentaires sur les paramètres d'entrée.
Il ne peut y avoir de lignes vides entre les commentaires et les fonctions de la documentation.
Si les étapes internes de la fonction sont complexes, vous devez rédiger des "commentaires en ligne".
Par exemple :

/**
 * 更新blog
 * @param int $id blog_id
 * @param array $data array(
    "content" => "", //内容
    "tags" => "", //标签
    "update_time" => "", //更新时间
 )
  * @return bool
 */
public function updateBlog($id,$data)
{
    step1 //第一步：asdf
    step2 //第二步：qwer
}

URI：
根据rfc1034国际标准的规定，域名中禁止出现下划线“_”，域名不区分大小写。
比如http://dl_dir.qq.com/是错误域名。
http://example.com与http://EXAMPLE.COM相同。
所以优先在URI中使用全小写，GET的name小写，但是GET的值除外。
比如
http://www.google.com/?hl=zh-CN
http://www.google.com/?hl=zh-cn
URI中非参数的专有名词的缩写是否使用小写，有争议无定论。
比如
http://fedoraproject.org/zh_CN/
http://zh.wikipedia.org/zh-cn/
http://code.google.com/intl/zh-CN/
http://www.microsoft.com/en-us/
语言文字代码是专有名词，ISO规定必须是减号，且建议地区使用大写。
fedora的用法很奇怪，使用了自己制造的zh_CN，而不是zh-CN。而且不建议在URI中使用下划线。
wiki用了小写，google用了大写，微软用了小写。

优先在URI中使用减号“-”，而不是下划线，GET的name除外。
比如
http://example.com/1-2-2
http://example.com/?user_id=123
如果希望用户手动输入URI，则不要区分大小写，且优先使用小写，因为用户输入更方便。
实际情况是：用户一般是手动输入域名，而不手动输入URI，因为URI很长。在这种情况下，URI小写是否有意义，如果使用 http://example.com/?userId=123，变量名就可以使用驼峰$userId = $_GET['userId']，就能够和Java、C++保持一致，这样数据库也要驼峰命名。待讨论。讨论结果：使用?user_id=123。

变量：
全小写，下划线分隔，例如：$user_id。
与Java、C++不一致。讨论结果：使用$user_id。
类的成员变量、函数的形参、类实例化成一个对象，都遵守变量的命名规则。
原因：URI、数据库有小写惯例，从$_GET、$_POST中获得参数入库，所以用小写。
PHP内置变量$_GET、$_POST使用下划线开头，全大写。自定义的变量无论多么重要，都不要使用下划线开头，以免将来与内置变量冲突。
比如：不要使用$_PUT、$_DELETE。

常量：
全大写，下划线分隔。例如：const MEMCACHE_TTL = 600;

PHP短标签：
使用，不使用短标签。因为与xml冲突，且不利于部署。

类大括号换行：

可以采用大括号单独占一行，也可以大括号与别的放在一行，有争议无定论，待讨论。讨论结果：使用“同行”。

class UserModel {

}

支持换行者：
http://www.php.net/manual/zh/language.oop5.basic.php
http://pear.php.net/manual/en/standards.classdef.php

函数大括号换行：
有争议无定论，待讨论。讨论结果：使用“同行”。

function getUser() {

}

支持换行者：
http://www.php.net/manual/zh/language.oop5.basic.php
http://pear.php.net/manual/en/standards.funcdef.php

if大括号换行：
有争议无定论，待讨论。讨论结果：使用“同行”。
例如：

if(!empty($name)){

}

或者

if(!empty($name)) { //确定

}

支持换行者：
http://www.possibility.com/Cpp/CppCodingStandard.html#brace
http://www.php.net/manual/zh/language.oop5.basic.php
http://pear.php.net/manual/en/standards.control.php
switch大括号换行：
讨论结果：使用“同行”。

switch (...) {
    case 1:
        ...
        break;

    default:
}

支持换行者：
http://www.possibility.com/Cpp/CppCodingStandard.html#switch

数组小括号换行：
有争议无定论。讨论结果：使用“同行”。

$user = array(
    "id" => "123",
    "name" => "user1",
    "email" => "a@example.com",
)

支持同行者：
http://pear.php.net/manual/en/standards.arrays.php

数组内部换行：
2维及以上数组的数组内部换行。
如：

$user = array(
    'id' => '123',
    'name' => 'user1',
    'email' => 'a@example.com',
);

1维数组内部不换行。讨论结果：1维数组内部不换行。
如：

$users_id = array('23','12','24');//确定

数组最后的逗号：
数组每一行最后要有逗号，这样方便以后添加。不过前端JSON最后不能有逗号，否则有的浏览器不支持，待讨论。讨论结果：都行，因为后端不用考虑IE前端。
比如

$user = array(
    'id' => '123',
    'name' => 'user1', //都行，优点：大数组，经常添加一行，方便。如果没有逗号，确实太难以添加了。
);
$user = array(
    'id' => '123',
    'name' => 'user1' //都行，优点：严谨，逗号表示分隔，最后一个不需要分隔。
);

单引号与双引号：
优先使用单引号，当需要转义时使用双引号，变量不放在双引号中。这与JSON不同，JSON全是双引号，待讨论。讨论结果：优先使用单引号。
比如：

echo 'name is:' . $name . '.' . "\n";
$user = array(
    'id' => '123',
);

条件判断的大括号：
必须有大括号，即使只有一行。
正确：

if(!empty($name)){
    doSomething();
}

错误：

if(!empty($name))
    doSomething();

回车换行：
使用换行LF（\n，0a，Unix风格）。不使用CR+LF（Windows风格）。
参考：http://zh.wikipedia.org/zh-cn/%E6%8F%9B%E8%A1%8C
eclipse——》workspace——》New text file line delimiter——》Other：Unix

编码：
使用UTF-8 no BOM。不得使用Windows记事本进行保存，因为记事本是UTF-8 BOM CR+LF。
eclipse——》workspace——》Text file encoding——》Other：UTF-8

缩进：
使用4个空格进行缩进，也可以采用tab进行缩进。讨论结果：4个空格。
支持4个空格者：//确定
http://www.oracle.com/technetwork/java/codeconventions-136091.html#262

支持2个空格者：
http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Spaces_vs._Tabs

支持3、4或8个空格者：

http://www.possibility.com/Cpp/CppCodingStandard.html#indent

要保证缩进正确，如果使用4个空格，一定不要出现5个空格或者11个空格。
eclipse——》General——》Editor——》Text Editors——》show whitespace characters
vim ~/.vimrc
set expandtab
set softtabstop=4
set shiftwidth=4
set autoindent

HTTP协议缓存：
文章使用Last Modified表示最后修改时间，不禁止缓存。

header('Last Modified:Sat, 30 Oct 2010 13:21:21 GMT');

需要用户登录的页面，禁止缓存。

header('Cache-Control:max-age=0');
header('Cache-Control:private');

HTTP协议编码与mime：
HTTP输出一定要声明编码与mime。charset与分号之间要有一个空格。小写utf-8还是大写UTF-8，尚未找到文档，待调研。
比如

header('Content-Type:application/json; charset=UTF-8');
header('Content-Type:application/xml; charset=UTF-8');
header('Content-Type:application/xhtml+xml; charset=UTF-8');
header('Content-Type:text/plain; charset=UTF-8');
header('Content-Type:text/html; charset=UTF-8');

专有名词大小写：
在类、函数、文件名、目录名等各种地方，不特殊对待专有名词，不采用全大写。讨论结果：使用小写。
原因：专有名词难以界定，比如HTML、CSS、CRUD。而且全大写导致与驼峰冲突，比如页面助手类，全大写是HTMLHelper，不如HtmlHelper。
支持不特殊处理：
HTML是专有名词，但mime中就使用Content-Type:text/html，而不是text/HTML。
例子：
采用UserDb.php，而不是UserDB.php。

相关推荐：

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!