DoitPHP-Codierungsspezifikationen

Anwendungsbereich Sofern nicht anders angegeben, gelten die folgenden Regelanforderungen vollständig für DoitPHP-Projekte (Hinweis: Die PHP-Framework-Datei von Doitphp, nicht PHP-Projekte, die mit DoitPHP entwickelt wurden). Wenn Ihnen die folgenden Codierungsstandards gefallen, können Sie diese auch in anderen PHP-Entwicklungsprojekten verwenden.

Die Bedeutung und Vorteile der Standardisierung „Keine Regeln, keine Quadrate.“ Wenn die Entwicklung eines Softwareprojekts öffentlichen und konsistenten Standards folgt, entwickeln und pflegen alle Teammitglieder einen konsistenten Codierungsstil und das gesamte Projektdokument wird von einer Person geschrieben . Der Code jedes Programmierers ist für andere leicht verständlich, was die Wartbarkeit des Codes verbessert und somit die Wartungskosten der Software senkt. Gleichzeitig können sich neue Teilnehmer schnell an die Umgebung anpassen und so die Effizienz der Teamentwicklungszusammenarbeit maximieren. Langfristige standardisierte Codierung kann es Entwicklern auch ermöglichen, gute Codierungsgewohnheiten zu entwickeln, die Wahrscheinlichkeit von Codierungsfehlern zu verringern und sogar strengeres Denken zu entwickeln. Der Zweck der „Dokumentation“ der Spezifikationen besteht darin, unsere Codierungsstandards zu verdeutlichen. Wir glauben, dass Standards nicht der Schlüssel zum Projekterfolg sind, aber sie können uns helfen, die Zusammenarbeit im Team effizienter zu gestalten und festgelegte Aufgaben reibungsloser zu erledigen.

PHP-Codierungsspezifikationen und -prinzipien 1. Dateiformat 1.1. Dateicodierung: Die Dateicodierung ist auf UTF-8 vereinheitlicht (Hinweis: nicht UTF-8+BOM). 1.2. PHP-Code-Tags: Verwenden Sie jederzeit „“ Und „“ wird verboten. Bei Codedateien, die nur PHP enthalten, wird empfohlen, das „?>“ am Ende der Datei zu ignorieren, um zu verhindern, dass zusätzliche Leerzeichen oder andere Zeichen den Code beeinträchtigen. 1.3. Einrückungsregeln: Verwenden Sie zum Einrücken 4 Leerzeichen anstelle von TAB. Dies ist bereits der Standard in der PHP-Branche und wir werden nicht „gegen den Trend der Geschichte“ verstoßen. Der Hauptgrund für die Verwendung von Leerzeichen besteht darin, den Code sauber und ordentlich aussehen zu lassen. Denn in verschiedenen Editoren ist die Länge des Tabulatorzeichens TAB unterschiedlich, der Leerraum jedoch gleich. Die Verwendung von TAB kann das Problem durch Drücken der TAB-Taste lösen. Bei der Verwendung von Leerzeichen muss die Leertaste jedoch viermal gedrückt werden, was sich offensichtlich auf die Entwicklungseffizienz auswirkt. Derzeit verwenden viele Editoren standardmäßig ein TAB, das vier Leerzeichen einnimmt (wie viele Leerzeichen es einnimmt, kann vom Editor angepasst werden). Um die Entwicklungseffizienz zu verbessern, können Sie TAB mit Sicherheit und Fettdruck verwenden. Diese Einrückungsspezifikation gilt auch für Funktionen, Klassen, logische Strukturen, Schleifen usw. in JavaScript. 1.4. Codeinhalt: Am Ende jeder Zeile sind keine zusätzlichen Leerzeichen oder Tabulatorzeichen zulässig (stellen Sie sicher, dass Ihr Editor die Datei im Unix-Format speichert, was bedeutet, dass Zeilen mit Zeilenumbrüchen abgeschlossen werden). Mit Ausnahme der Konfigurationsdatei für Sprachpaketanmerkungen darf es nirgendwo anders Chinesisch geben. 1.5. Codekommentare: Dateien müssen klare Codekommentare haben und der Kommentarstil übernimmt den phpDocumentor-Standard