Teilen Sie einige Standardbeispiele für PHP

In diesem Artikel werden hauptsächlich einige Standardbeispiele für PHP vorgestellt. Ich hoffe, es hilft allen. Bitte beachten Sie bei der Formulierung von Spezifikationen: Im Allgemeinen sollte es keine Situation geben, in der beides akzeptabel ist. Beispielsweise funktionieren sowohl Tabulatoren als auch vier Leerzeichen, aber das Ergebnis ist verwirrender Code.

Allgemeine Grundsätze:
1. Semantik
Wenn Sie den Namen sehen, kennen Sie die Bedeutung.

2. Das gemeinsame Präfix
bedeutet ob, get bedeutet lesen und set bedeutet schreiben. Auf „is“ folgen zunächst Adjektive und nicht Substantive. Wenn der Text beispielsweise mehrsprachig ist, sollte „is_multilingual“ anstelle von „is_multilingual“ verwendet werden.

3. Singular und Plural
Beachten Sie die Benennungsregeln für Funktionen von js: getElementById, getElementsByTagName, getElementsByName.
Zum Beispiel:
Um die Namen meiner mehreren Freunde zu erhalten, sollten Sie getFriendsName anstelle von getFriendNames oder getFriendName verwenden
Um einen Benutzer zu erhalten, getUser
Um mehrere Benutzer zu erhalten, getUsers

4. Redundante Suffixe
Versuchen Sie, keine Daten-, Listen- und Info-Suffixe zu verwenden, es sei denn, es liegen besondere Umstände vor.
Achten Sie beispielsweise auf die Benennung von js und verwenden Sie getElementsByTagName anstelle von getElementsInfoByTagName.
Sie sollten getFriends oder getFriendsUserId anstelle von getFriendsList verwenden. Sie sollten getUser anstelle von getUserInfo oder getUserData verwenden.
Aber manchmal ist es schwer, dies zu vermeiden. Beispielsweise gibt es zwei Funktionen: Die eine besteht darin, die grundlegenden Informationen des Benutzers abzurufen, und die andere darin, detaillierte Informationen des Benutzers abzurufen.
Grundlegende Benutzerinformationen abrufen: Spitzname, Avatar-URI, Funktionsname getUserBasic oder getUserBasicInfo? Funktionsnamen, die mit Adjektiven enden, erscheinen uns unangemessen. Zur Diskussion. Diskussionsergebnis: getUserBasicInfo ist geeignet.
Benutzerdetails abrufen: Spitzname, Avatar-URI, Signatur, Geburtstag, Funktionsname getUser ist kein Problem.

5. Mehrdeutige Klassennamen, Dateinamen und Verzeichnisnamen
Seien Sie vorsichtig, wenn Sie „Common“, „Util“, „Functions“, „Class“, „Object“ und „Basic“ als Dateinamen verwenden, da diese Wörter zu häufig und schwierig sind Wenn Sie nach unten gehen, kann es sein, dass sich immer mehr Dinge darin befinden und sich in einen Mülleimer verwandeln. Geben Sie diesen einen korrekten Namen. Beispielsweise kann eine Klasse, die Zeichenfolgen verarbeitet, StringLib.php heißen und im lib-Verzeichnis abgelegt werden.

6. Der Unterschied zwischen lib, Plugin und Addon
Einige Klassen und Funktionen werden als lib, Plugin oder Addon gezählt. Zur Diskussion. Diskussionsergebnisse: Die aktuelle Erweiterungsfunktion ist Lib. Plugins und Add-Ons werden später berücksichtigt.

7. Häufig verwendetes Vokabular
Verwenden Sie zuerst URI, nicht URL. Aufgrund der höheren Strenge begann man bei der neuen Benennung mit der Verwendung von URI. Zum Beispiel der encodeURI von js, der $_SERVER['REQUEST_URI'] von PHP.
Deadline und TTL: Deadline repräsentiert den letzten Moment und TTL repräsentiert die Überlebenszeit. Wenn die aktuelle Zeit beispielsweise 1310449710 ist und die TTL 60 Sekunden beträgt, ist die Frist 1310449710 + 60 = 1310449770.

Klassenname:
Beginnen Sie mit einem Großbuchstaben und verwenden Sie die Groß-/Kleinschreibung. Verwenden Sie im Allgemeinen Substantive, z. B. die Konfigurationsanalyseklasse ConfigParser anstelle von ParseConfig.
Das Gleiche wie Java und C++.
Zum Beispiel: Klasse UserModel

Der Dateiname der Klasse:
ist derselbe wie der Klassenname. Dies hängt mit dem automatischen Laden von PHP zusammen. Der Klassenname muss immer sehr lang sein. Zur Diskussion. Diskussionsergebnis: Das automatische Laden von Klassen kann auch durch Einhaltung des Camel Case erreicht werden.
Konsistent mit Java.
Zum Beispiel: Der Dateiname der Klasse UserModel ist UserModel.php

Nicht-Klassen-Dateiname:
Alle Kleinbuchstaben, durch Unterstriche getrennt, keine Leerzeichen erlaubt. Zum Beispiel get_user.php.

Verzeichnisname:
Alles in Kleinbuchstaben, durch Unterstriche getrennt, keine Leerzeichen erlaubt. Wie Modell, www.

Funktionsname:
Beginnen Sie mit einem Kleinbuchstaben und werden Sie in Kamelbuchstaben benannt, zum Beispiel: Funktion addBlog().
Das Gleiche wie Java und C++.
Funktion stellt eine Funktion dar, also eine Aktion, daher hat das Verb Vorrang. Verwenden Sie beispielsweise editBlog anstelle von blogEdit.
Aus historischen Gründen haben die integrierten Funktionen von PHP viele Stile, wie z. B. do_something, Something_do, dosomething. Die neueren Funktionen verwenden doSomething, um mit den aktuellen Mainstream-Sprachen konsistent zu sein.
Zum Beispiel: paser_str, json_encode, substr, fetchAll.
Historische Gründe dürfen nicht geändert werden, aber wir können sicherstellen, dass der neue Kodex streng ist und uns nicht zu historischen Gründen machen lassen.

Funktion im Unterricht:
Zwischen den beiden Funktionen steht eine Leerzeile. Wenn Sie Zeit haben, sortieren Sie die Funktionen alphabetisch, um zu viel Verwirrung zu vermeiden.
Zum Beispiel:

class BlogModel
{
    public function addBlog()
    {

    }
    
    public function updateBlog()
    {

    }
}

Dateikommentar:
Der Kommentar folgt unmittelbar auf die nächste Zeile von Das Format folgt den Anforderungen von PHPdoc: http://manual.phpdoc.org/HTMLframesConverter/default/phpDocumentor/tutorial_tags.author.pkg.html

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

}
?>

API Hinweise:
Stellen Sie sicher, dass Sie die Eingabeparameter und das Ausgabeformat schreiben. Schreiben Sie deutlich, was ausgegeben wird, wenn es richtig ist, und was ausgegeben wird, wenn es falsch ist.
Andernfalls können andere es nicht nutzen.

Funktionskommentare:
Stellen Sie sicher, dass Sie das Ausgabeformat schreiben. Schreiben Sie deutlich, was ausgegeben wird, wenn es richtig ist, und was ausgegeben wird, wenn es falsch ist.
Wenn die Eingabeparameter komplex sind und Arrays enthalten und die Parameter nicht auf einen Blick klar verstanden werden können, müssen Sie Kommentare zu den Eingabeparametern schreiben.
Zwischen Dokumentationskommentaren und Funktionen dürfen keine Leerzeilen stehen.
Wenn die internen Schritte der Funktion komplex sind, müssen Sie „Inline-Kommentare“ schreiben.
Zum Beispiel:

/**
 * 更新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规范解析

Das obige ist der detaillierte Inhalt vonTeilen Sie einige Standardbeispiele für PHP. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!