Wie schreibe ich schönen PHP-Code?

Eine gute Codierungsgewohnheit wird durch tägliche Gewohnheiten entwickelt. Wenn das Team über gute Codierungsstandards verfügt und jeder die festgelegten Codierungsstandards befolgt, dann glaube ich, dass die Qualität und Wartbarkeit des Codes auf ein höheres Niveau steigen wird. Derzeit muss PHP den PSR-Standards entsprechen. Zur Erläuterung werde ich nur einige häufig verwendete Schreibmethoden auflisten. Weitere Spezifikationen finden Sie in den PSR-Standards.

PHP-Datei-Start-Tag

Für reine PHP-Codedateien müssen sie mit 3925446cef75e5f8958b7dab82821fac-Tag hinzufügen Was den Grund angeht, denke ich. Wenn Sie interessiert sind, können Sie es selbst herausfinden.

<?php

class TestDemo
{
}

Deklaration der Klassenklasse

Der Klassenname muss in Großbuchstaben (TestDemo) benannt werden. Die beiden geschweiften Klammern werden umbrochen und belegen gleichzeitig eine exklusive Zeile erforderlich, um den Ersteller und die Funktion der Klasse usw. zu beschreiben.

/**
 * 这是一个测试Demo类
 * Author: gxcuizy
 * Date: 2021-05-25 13:57:16
 * Class TestClass
 */
class TestDemo
{
}

Konstanten der Klassenklasse

Die Konstanten in der Klasse müssen in Großbuchstaben (HELLO_WORLD) benannt werden, und die Wörter werden durch Unterstriche _ getrennt, und es ist am besten, einen einzelnen Kommentar hinzuzufügen -Zeilenkommentar nach // Lassen Sie ein Leerzeichen, gefolgt von einem Kommentar.

// 声明一个常量
const HELLO_WORLD = 'best';

Member-Attribute der Class-Klasse

Member-Attribute (auch Member-Variablen genannt) in der Klasse Die Benennung von Member-Attributen kann drei Regeln folgen: Camel Case beginnend mit Großbuchstaben ($UserName), Camel Case beginnend mit Kleinbuchstaben ($). userName), durch Unterstriche getrennt ($user_name); alle drei Namensregeln sind akzeptabel Gleichzeitig dürfen die drei Namensregeln Modifikatoren (öffentlich, geschützt, privat) nicht fehlen.

// 声明一个公共变量
public $user_name = '';
// 声明一个静态变量
public static $user_age = 18;

Member-Methoden der Class-Klasse

Bei der Benennung der Member-Methoden in der Klasse muss die Benennungsregel für Kamelbuchstaben (testAction) übernommen werden, beginnend mit Kleinbuchstaben. Die drei Modifikatoren der Methode (public, protected, private) dürfen nicht fehlen , und es gibt zwei geschweifte Klammern in einer neuen Zeile und eine eigene Zeile. Auf beiden Seiten des Gleichheitszeichens des Parameters sollten Sie die Kommentare zur Methode nicht verpassen die Methode, Parameterbeschreibung, Rückgabewertbeschreibung usw.

/**
 * 这是一个测试方法
 * @param string $msg 参数说明
 * @return array
 */
public function testAction($msg = '')
{
    // 返回数据格式
    $return = array('code' => 200, 'msg' => '');
    return $return;
}

/**
 * 这是私有方法，方法命名以单下划线开始
 * @param string $arg 参数说明
 * @return string
 */
private function privateAction($arg = '')
{
    return $arg;
}

Operatoren und Ausdrücke

Relativ zu Operatoren oder Ausdrücken unterschiedlichen Typs, unabhängig davon, wo sie verwendet werden, müssen wir auf beiden Seiten ihrer Symbole ein Leerzeichen haben, z. B. $a = 1;, 1 + 2 und 1 && 0 usw.

/**
 * 获取两个数相加的和
 * @param int $one 第一个数
 * @param int $two 第二个数
 * @return int
 */
public function getUserAge($one = 0, $two = 0)
{
    $sum = $one + $two;
    return $sum;
}

Die Standardmethode zum Schreiben von Kontrollstrukturen

ähnelt if...else, while, switch...case, foreach, for und anderen Prozesskontrollstrukturen. Grundsätzlich müssen sie mit Klammern () und verwendet werden Geschweifte Klammern {} und Klammern () sind erforderlich. Auf beiden Seiten befindet sich ein Leerzeichen, und die linke geschweifte Klammer {muss auf derselben Zeile wie die rechte geschweifte Klammer stehen) und hat ein Leerzeichen, und die schließende rechte geschweifte Klammer}. muss in einer separaten Zeile stehen und der Hauptinhalt ist in geschweiften Klammern {} enthalten.

/**
 * 判断用户是否成年
 * @param int $age 年龄
 */
public function logicAction($age = 18)
{
    if ($age >= 18) {
        echo '已成年';
    } else {
        echo '未成年';
    }
}

Schnelle Formatierung mit einem Klick

Viele IDEs unterstützen jetzt die Formatierung von Code mit einem Klick, z. B. PHPStorm usw. Die allgemeinen Tastenkombinationen sind Strg + Alt + L. Sie können die Tastenkombinationen und den Code auch entsprechend Ihren Anforderungen ändern Eigene Gewohnheiten Formatstandards, Sie können das gesamte Dokument mit einem Klick formatieren oder nur einen bestimmten Teil des Codes zum Formatieren auswählen. PS: Wenn diese Datei nicht von Ihnen selbst erstellt und geändert wird, formatieren Sie bitte nicht einfach die gesamte Datei mit einem Klick, da dadurch auch der Code anderer Personen formatiert wird. Es wird empfohlen, nur Ihren eigenen Code zu formatieren andere können nach Belieben mit meinem Code herumspielen, also mach keinen Ärger! Machen Sie keinen Ärger! Machen Sie keinen Ärger! Sagen Sie wichtige Dinge dreimal, wissen Sie.

Abschließende Zusammenfassung

Lassen Sie mich zunächst einige persönliche Vorschläge machen, ich hoffe, dass sie Ihnen hilfreich sein werden:

• Fügen Sie keine zusätzlichen Leerzeichen hinzu, das heißt, fügen Sie bei Bedarf nur ein Leerzeichen hinzu (folgen Sie einfach den Anweisungen). Codespezifikationen)

• Löschen Sie unnötige Zeilenumbrüche (beeinträchtigt die visuelle Schönheit des Codes)

• Denken Sie daran, den Debugging-Code rechtzeitig zu löschen, nicht nur die Kommentare (ich fürchte, Sie werden ihn mit der Zeit vergessen)

• Codekommentare, Codekommentare, Codekommentare (Egal wie beschäftigt Sie sind, Sie sollten entsprechende Kommentare schreiben, fügen Sie sie später nicht hinzu)

• Sie können sich den Code anderer Leute ansehen, aber andere nicht ändern Sie können den Code der Leute nach Belieben ändern (weil andere nicht gerne Ihren Code sehen)

Ich habe gerade einen kleinen Teil der häufig verwendeten Codespezifikationen extrahiert, um darüber zu sprechen. Wenn beim Schreiben etwas nicht stimmt, weisen Sie es bitte darauf hin und ich werde es rechtzeitig ändern. Vielen Dank. Wenn Sie über weitere gute Programmierkenntnisse verfügen, können Sie diese gerne mit allen teilen.

Empfohlenes Lernen: php-Video-Tutorial

Das obige ist der detaillierte Inhalt vonWie schreibe ich schönen PHP-Code?. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!