PHP-Codestil

Wenn Sie ein Drittanbieter-Framework verwenden und Anweisungen zum Codestil bereitstellen, befolgen Sie dessen Codestilstandards, andernfalls wie folgt!

== Format:

* UTF-8-Kodierung verwenden

* 4 Leerzeichen zum Einrücken verwenden, Tabulatoren sind verboten

* Zeilenumbrüche im Unix-Stil ( LF)

* Verwenden Sie Leerzeichen für Komma-, Doppelpunkt- und Semikolon-Operatoren

* Verwenden Sie keine Leerzeichen vor (, [ nach, ],)

* im Code Verwenden Sie 4 Leerzeichen für Einrückungen in Blöcken

* Hierarchische Einrückung verwenden

* Verwenden Sie eine Leerzeile vor dem Rückgabewert der Rückgabemethode (es sei denn, es gibt nur eine Codezeile) und verwenden Sie Leerzeilen zwischen zwei Methoden Zeilendifferenzierung

* Verwenden Sie Leerzeilen, um zwischen zwei großen logischen Codesegmenten zu unterscheiden

* Halten Sie die Anzahl der Zeilen auf 80 Wörter, nicht mehr als 120

* Verwenden Sie Standard-PHP Tag-Trennung, die Verwendung von kurzen Tags () ist verboten, und für Dateien, die nur PHP-Code
enthalten, ist die Verwendung von PHP-End-Tags ("?>") verboten , verwenden Sie den Kommentar „/* End of file */“ am Ende der Datei

* Eine einzelne Codezeile muss außerdem mit einem Semikolon (;)
== Benennung:

* Verwenden Sie die Methode „snake_case“ für Dateinamen und verbieten Sie die Verwendung aufgeblähter Dateinamen

* Verwenden Sie die Methode „snake_case“ für Variablennamen und verbieten Sie die Verwendung aufgeblähter Variablennamen
* Die Verwendung einzelner Zeichen als lokale Variablen (z. B. $i) verbieten, außer in for-Schleifen
* Es ist verboten, Großbuchstaben als globale Variablen zu verwenden, sollte SCREAMING_SNAKE_CASE verwendet werden

* Verwenden Sie CamelCase für Klassennamen und camelCase für Methodennamen (Behalten Sie Abkürzungen wie HTTP, RFC, XML in Großbuchstaben bei)

* Verwenden Sie SCREAMING_SNAKE_CASE für Konstantennamen

// bad
superclass.php
SuperClass.php
superClass.php
$i = "foobar";  // 单字符变量只充许使用在for循环中
$bufferdText   // 驼峰式变量，并且意思可以再精简些
$groupid        // 两个单词之间需要下划线分开
$name_of_last_city_used // 太长
MyConstant       // 应该用下划线并且字母没有全大写
N                     // 单字符
S_C_VER           // 意思不清楚
class superclass
class superClass
function fileproperties() // 意思不清楚并且没有驼峰式命名
function fileProperties() // 意思不清楚
function getfileproperties() // 好些了，但没有驼峰式命名
// good
super_class.php
for ($i = 0; $i < 10; $i++)
$buffer
$group_id
$last_city
MY_CONSTANT
NEWLINE
SUPER_CLASS_VERSION
class SuperClass
function getFileProperties()

== Syntax :

Für in HTML-Code eingebettetes PHP verwenden Sie für Codeblöcke wie if, for, foreach, while usw. if: ... endif for: ... endforeach; ; und while: ... endwhile; Methodenblöcke

...
<?php if ($user->isLoggedIn()): // checking logged in ?>
<!-- HTML goes here. -->
<?php endif; // end checking logged in ?>
<?php foreach ($users as $user): // loop users ?>
<!-- HTML goes here. -->
<?php endforeach; // end loop users ?>
...

== Hinweis:

* Der Dokumentblock muss mit dem phpDocumentor-Format kompatibel sein, siehe: http://phpdoc. org/

* Vermeiden Sie überflüssige Kommentare

/**
 * 控制器类说明信息
 */
class Controller {
    private static $instance;
    public function __construct()  {
        ...
    }
    /**
     * 函数说明信息
     */
    public static function &get_instance() {
        ...
    }
/* End of file controller.php */