PHP - standard kodowania
Każda firma stosuje inny standard kodowania oparty na najlepszych praktykach. Standard kodowania jest wymagany, ponieważ może być wielu programistów pracujących nad różnymi modułami, więc jeśli zaczną wymyślać własne standardy, źródło stanie się bardzo trudne do zarządzania i trudno będzie utrzymać ten kod w przyszłości.
Oto kilka powodów, dla których warto używać specyfikacji kodowania -
Twoi rówieśnicy programiści muszą zrozumieć kod, który tworzysz. Standard kodowania działa jako plan dla całego zespołu do rozszyfrowania kodu.
Prostota i przejrzystość osiągnięta dzięki konsekwentnemu kodowaniu chroni Cię przed typowymi błędami.
Jeśli po pewnym czasie poprawisz swój kod, zrozumienie tego kodu stanie się łatwe.
Jest to standard branżowy zgodny z określonym standardem, aby zapewnić wyższą jakość oprogramowania.
Jest kilka wskazówek, którymi można się kierować podczas kodowania w PHP.
Indenting and Line Length- Użyj wcięcia 4 spacji i nie używaj żadnej tabulacji, ponieważ różne komputery używają różnych ustawień tabulacji. Zaleca się, aby linie miały długość około 75-85 znaków, aby zapewnić lepszą czytelność kodu.
Control Structures- Należą do nich if, for, while, switch itp. Instrukcje sterujące powinny mieć jedną spację między słowem kluczowym control a nawiasem otwierającym, aby odróżnić je od wywołań funkcji. Zdecydowanie zachęcamy do używania nawiasów klamrowych, nawet w sytuacjach, gdy są one technicznie opcjonalne.
Examples
if ((condition1) || (condition2)) {
action1;
}elseif ((condition3) && (condition4)) {
action2;
}else {
default action;
}
Możesz pisać instrukcje przełączania w następujący sposób -
switch (condition) {
case 1:
action1;
break;
case 2:
action2;
break;
default:
defaultaction;
break;
}
Function Calls- Funkcje należy wywoływać bez spacji między nazwą funkcji, nawiasem otwierającym i pierwszym parametrem; spacje między przecinkami a każdym parametrem, bez spacji między ostatnim parametrem, nawiasem zamykającym i średnikiem. Oto przykład -
$var = foo($bar, $baz, $quux);
Function Definitions - Deklaracje funkcji są zgodne ze "stylem BSD / Allman" -
function fooFunction($arg1, $arg2 = '') {
if (condition) {
statement;
}
return $val;
}
Comments- Komentarze w stylu C (/ * * /) i standardowe komentarze w C ++ (//) są w porządku. Używanie komentarzy w stylu Perl / powłoki (#) jest odradzane.
PHP Code Tags- Zawsze używaj <? Php?> Do oddzielania kodu PHP, a nie <? ?> skrót. Jest to wymagane do zapewnienia zgodności z PHP i jest również najbardziej przenośnym sposobem dołączania kodu PHP w różnych systemach operacyjnych i konfiguracjach.
Variable Names -
- Użyj wszystkich małych liter
- Użyj znaku „_” jako separatora słów.
- Zmienne globalne należy poprzedzić literą „g”.
- Stałe globalne powinny mieć wielkie litery z separatorami „_”.
- Zmienne statyczne można poprzedzić znakiem „s”.
Make Functions Reentrant - Funkcje nie powinny zachowywać zmiennych statycznych, które uniemożliwiają ponowne wprowadzenie funkcji.
Alignment of Declaration Blocks - Blok deklaracji powinien zostać wyrównany.
One Statement Per Line - W każdym wierszu powinno znajdować się tylko jedno stwierdzenie, chyba że stwierdzenia są bardzo ściśle powiązane.
Short Methods or Functions - Metody powinny ograniczać się do jednej strony kodu.
Może być o wiele więcej punktów, które należy wziąć pod uwagę podczas pisania programu PHP. Ogólnym zamiarem powinno być zachowanie spójności w całym programowaniu kodu, a będzie to możliwe tylko wtedy, gdy będziesz postępować zgodnie z jakimkolwiek standardem kodowania. Możesz ustawić swój własny standard, jeśli lubisz coś innego.