Стандарт за писане на код в PHP
- thelordofweb
- 47 791 прочитания
Урокът е от архива на сайта и е писан преди години. Някои бутони и менюта в програмите вече може да изглеждат различно.
Този стандарт е базиран на C ++ стандарта за писане на код създаден от Тод Хоф.
Преработен е за PHP от Фридрик Кристиансен
- Въведение
- Имена
- Конструкции и подредба на кода
- Документация и коментари
- Други
Какво му е хубаво на стандартизацията?
Когато проект се придържа към общ стандарт, програмистите могат да пишат какъвто и да е код и винаги ще знаят какво се случва. При нови хора в екипа или при разглеждане на скрипта от трети лица, че им е нужно много малко време за да навлезнат в нещата.
Хората пишещи на PHP имат възможност и нужда да развиват личен стил и да го защитават. Също така програмистите ще правят по-малко грешки, ако се намират в познати среди. По този начин те ще имат общ враг : -)
Какво лошото казват за стандарта?
- Стандарта обикновено го имат за безсмислен, защото е направено от някой, който не разбира PHP
- Стандарта обикновено е безсмислен защото не е това, което аз правя
- Стандартите ограничава градивния характер
- Стандартите са ненужни докато хората са последователни
- Стандартите налагат твърде много структура
- Хората игнорират стандартите винаги
Дискусия
Опитът с много проекти ме довежда до заключението, че от използването на стандарти за писане на код, проекта извлича само ползи. Стандарти необходими ли са за успех? Разбира се не. Но те помагат, и ние се нуждаем от цялата помощ, която ние можем да получим! Бъдете честни, повечето аргументи срещу определен стандарт идват от егото. Бъдете гъвкави, контролирайте егото , и си спомнете, че какъвто и да е проекта в основата си зависи от екипа.
Във всички случаи, хора ще пораснат и разберат, какво е за тяхно добро, че този стандарт е разумен, и се намира за добър от много програмисти, и затова е достоен за следване дори с лични резерви.
ИменаИмената са сърцето на програмирането. В миналото хората са вярвали , че знаейки истинското име на някой ще им даде магична власт над този човек. Ако вие можете да измислите истинско име за нещо, вие, както и хората идващи след вас придобивате сила над кодът. Не се смейте!
Само програмист, който разбира системата изцяло може да създаде име, което си "пасва" със системата. Ако името е подходящо, всичко ще е в хармония, връзките и значението им са ни ясни, ще е разбираемо за обикновения човек и всичко ще работи според очакванията ни.
Имена на класове
- Избирайте име на клас в зависимост от това, което е.
- Съединяването на над три думи в име са признак, че вашият дизайн може да е грешна смесица от разнообразни обекти. Погледнете отново вашият дизайн.
- Избягвайте изкушението да вземате имена на класове, произлизащи от уроците тук или някъде другаде. Класа трябва да е създаден без чужда помощ. Няма значение от къде произлиза идеята за него.
- Наставките понякога са полезни. Например, ако вашата система използва агенти за сваляне, тогава назовавайки го DownloadAgent ще представлява достоверна информация.
Имена за функции и методи
- Наставките понякога са полезни :
- Max - ще се има на предвид максималната стойност от нещо.
- Cnt - текущия брой на нещо.
- Key - ключова стойност.
Пример:
RetryMax ще има предвид максималният брой опити, RetryCnt ще изброи опитите.
- Представките понякога са полезни :
oIs – Така питаме за нещо. Винаги когато някой вижда Is ще знае, че това е въпрос.
oGet - Получаваме стойност
oSet – Задаваме стойност
Пример : IsHitRetryLimit
Не се допускат абревиатури изцяло с главни букви
В някой ситуация вие може да желаете да използвате пълното изписване на абревиатурите с главни букви, но това ще е грешка. Те се изписват с главни буква в началото, следвани от малки до края и. Без значение какво е.
Пример :
Използувайте : GetHtmlStatistic.
Не използувайте : GetHTMLStatistic.
Хората изглеждат имат много различни интуиции, при писането на имена делящи се на съкращения. Най-добре е да се установи една стратегия, така че имената абсолютно да са предсказуеми.
Вземете например NetworkABCKey. Забележете как C от ABC и K от ключ ни бъркат. Някой хора не му обръщат внимание, а други го мразят. Вие ще се сблъскате с различни видове политика на писане в кодовете, така че не се знаете какво може да очаквате.
Пример :
class FluidOz // Не FluidOZ
class GetHtmlStatistic // Не GetHTMLStatistic
Имена на класове
·Използвайте главни букви като сепаратори(разделители) на думите, намалете използваните думи за останалата част на името на класа до минимум (максимално 3 думи)
·Първият знак в името на класа трябва да бъде главна буква
·Не използвайте (‘_’) за разделител между думите
От всички различни видове за наименуване много хора намериха този за най-добрият компромис.
Пример:
class NameOneTwo
class Name
В днешно време се използват страшно много класове, както наши така и от различни източници. Трябва да използваме пространствата на имената за да предотвратим конфликт между два класа.
Щом като не използваме интервали между имената, предотвратяването на конфликт между класовете може да осъществим, чрез слагане на представка, която класифицира името с уникална поредица от символи. Два знака е задоволително, но по-дълга част на представката ще е по-добре.
Пример:
За класа на Тодор Илиев може да използуваме ТИ като представка, така класове ще бъдат :
class ТиLinkList
{
}
Имена на методи
- Тук важат същите правила, които използвахме при имената на класовете
Пример:
class NameOneTwo
{
function DoIt() {};
function HandleError() {};
}
Имена на атрибути в класовете
- Атрибут, който е член на класът трябваше да започва със знака „m”.(идва от „member”)
- След „m” използувайте за наименуване правилата, които използваме при наименуването на клас или метод.
- „m” винаги предхожда другите указатели , като например “r” за референция.
Поставянето на „m” предотвратява какъвто и да е конфликт с имената на методите. Често вашите методи и имената на атрибутите ще бъдат подобни при изписване.
Пример:
class NameOneTwo
{
function VarAbc() {};
function ErrorNumber() {};
var $mVarAbc;
var $mErrorNumber;
var $mrName;
}
Аргументи при методите
- Първия знак трябва да бъде малка буква.
- Всяка нова дума след първата трябва да започва с главна буква, както е при по-горните примери.
Вие винаги можете да кажете кои променливи са подадени като атрибути.
Пример:
class NameOneTwo
{
function StartYourEngines(&$someEngine, &$anotherEngine) {
$this->mSomeEngine = $someEngine;
$this->mAnotherEngine = $anotherEngine;
}
var $mSomeEngine;
var $mAnotherEngine;
}
Имена на променливи
- Използвайте винаги малки букви за изписването на променливите
- За разделите използвайте „_”
С този подход областта на променливата е ясна в кодът. Променливите изглеждат различни и са лесно идентифицируеми.
Пример :
function HandleError($errorNumber)
{
$error = new OsError;
$time_of_error = $error->GetTimeOfError();
$error_processor = $error->GetErrorProcessor();
}
Елементи на масив
Имената на елементите на масивът следват същите правила като променливите.
- За разделител между думите използвайте „_”
- Не използвайте за разделител на думите „-„
Ако използвате „-„ ще получите съобщение за грешка в определени ситуации.
Пример:
$myarr['foo_bar'] = 'Hello';
print "$myarr[foo_bar] world"; // Ще изведе: Hello world
$myarr['foo-bar'] = 'Hello';
print "$myarr[foo-bar] world"; // Съобщение да внимаваме
- Достигнете елементите на масива чрез единични или двойни кавички.
- Не използвайте кавички, когато са включени „магическите кавички”.
Някои конфигурации на PHP ще изведат предупреждение за грешка, ако масивите са използувани без кавички, освен когато са включени „магическите кавички”.
Пример:
$myarr['foo_bar'] = 'Hello';
$element_name = 'foo_bar';
print "$myarr[foo_bar] world"; // Ще изведе: Hello world
print "$myarr[$element_name] world"; // Ще изведе: Hello world
print "$myarr['$element_name'] world"; // Ще изведе съобщение за грешка
print "$myarr["$element_name"] world"; // Ще изведе съобщение за грешка
Референции към променливи и функции връщащи референция
- Името на променливата, която е референция трябва да започва с „r”.
Така ще ни е ясна разликата между видове променливи.
Можем да установим разликата между метод връщащ променлива, която е референция и метод връщащ нормална променлива.
Пример:
class Test
{
var $mrStatus;
function DoSomething(&$rStatus) {};
function &rStatus() {};
}
Глобални променливи
- Имената на глобалните променливи са предхождани от “g”
Важно е да знаете областта на променлива.
Пример:
global $gLog;
global &$grLog;
Дефиниране на имена за глобални константи
- Думите в името на константата трябва да бъдат разделени с “_” и винаги написани с главни букви.
Пример:
define("A_GLOBAL_CONSTANT", "Hello world!");
Статични променливи
- Имената на статичните променливи могат да бъдат предхождани от “s”.
Пример :
function test()
{
static $msStatus = 0;
}
Имена на функции
Функциите се именуват изцяло с малки букви, а за разделител между думите се използва „_”.
Така ние ще може да е разграничим от класовете, дори и да има прилика помежду им.
Пример :
function some_bloody_function()
{
}Конструкции и подредба на кода
Политика при връщане на грешки
- Проверете всяко съобщение за грешка, освен ако искате да игнорирате грешките.
- Включете текст към всяко системно съобщение за грешка.
Скоби
Има няколко начина за използване на скоби , но два от тях са предпочитани:
- Поставете скоба под и в една линия с ключовите думи :
if ($condition) while ($condition)
{ {
... ...
} }
- Традиционно за UNIX е поставяне на първоначалната скоба върху същата линия където е ключовата дума:
if ($condition) { while ($condition) {
... ...
} }
Всяка форма е приемлива, но много хора намират първата форма по-приятна. Защо? Нека да кажем, че вие имате голям блок код и искате да знаете къде свършва блокът. Вие премествате към първата скоба, която е отворила блока и тя се откривате по-лесно, отколкото ако е в края на дълъг ред с условия.
Пример:
if ($very_long_condition && $second_very_long_condition)
{
...
}
else if (...)
{
...
}
Абзаци , табулация и разстояния
- Абзаците използват 4 интервала при всяко ниво.
- Не използвайте табулация, употребявайте интервалите. Повечето редактори могат да заменят интервалите с табулация.
- Не използвайте повече нива при нареждането на блоковете от колкото е необходимо. Има някакви своеволни правила относно максималното пренареждане при нивата на блоковете. Ако нивата са повече от 4 - 5 вие можете да се замислите относно разлагане на кода.
- Когато хората използуват различни настройки на табулацията, кодът е невъзможен за четене или отпечатване, което обяснява защо интервалите са за предпочитане пред табулацията.
- Повечето приложения на PHP използуват 4 интервала.
- Повечето редактори използуват 4 интервала по подразбиране.
Пример:
function func()
{
if (Нещо лошо)
{
if (Нещо друго лошо)
{
while (Още входящи)
{
}
}
}
}
Скобите „()” заедно с ключови думи и функции
- Не поставяйте „()” до ключови думи. Оставете пространство помежду им.
- Поставете „()” до имената за функциите.
- Не използувайте „()” когато не е необходимо.
Ключовите думи не са функции. Като поставяме скобите до ключови думи правим така, че ключовите думи и имената на функциите да изглеждат подобно.
Пример :
if (условие)
{
}
while (условие)
{
}
strcmp($s, $s1);
return 1;
Не извършвайте стандартни действия в конструкторите на обектите
- В конструктора се инициализират променливи и / или се изпълняват действия, които не могат да се избегнат и са ни нужни за правилната работа на обекта.
- Конструкторите не могат да върнат грешка.
Пример :
class Device
{
function Device() { /* Инициализирам/нещо друго */ }
function Open() { return FAIL; }
};
$dev = new Device;
if (FAIL == $dev->Open()) exit(1);
If Then Else формат
Тука много зависи от програмистът. Различните стилове ще дадат леко различен поглед на кода. Един обикновен начин на писане при тази конструкция, който ни доближава е :
if (условие) // Коментар
{
}
else if (условие) // Коментар
{
}
else // Коментар
{
}
Винаги поставяйте константата в лявата страна на сравнението на равенство/неравенство.
Пример:
if ( 6 == $errorNum ) ...
При писането по този начин на сравнението парсера бързо ще открие грешката и ще прекрати изпълнението на израза, ако е нужно. Така печелите време при изпълнението на скриптовете.
switch формат
- Последователното преминаване през случаи е допустимо, но трябва да добавим коментар описващ случилото се.
- Клаузата default трябва винаги да присъства и при възникване на грешка switch ще ни отведе до нея.
- Ако дефинирате променлива, добавете целия код в блока на случая.
Пример :
switch (...)
{
case 1:
...
// FALL THROUGH
case 2:
{
$v = get_week_number();
...
}
break;
default:
}
Използването на continue, break and ?:
Continue и Break
Два опасни проблема с Continue:
- Може да заобиколи тестовото състояние
- Може да заобиколи изразът за увеличение/намаляване
Пример :
while (TRUE)
{
...
// Много код
...
if (/* някакво условие */) {
continue;
}
...
// Много код
...
if ( $i++ > STOP_VALUE) break;
}
? :
Ето някой правила които трябва да следваме:
- Поставете условието в „()” за да задействаме другия код.
- Ако е възможно, действията при който тестваме трябва да бъдат елементарни функции.
- Поставете действията на отделен ред тогава, когато не може да бъдат описани ясно на един ред.
Пример :
(условие) ? funct1() : func2();
или
(условие)
? дълъг израз
: друг дълъг израз;
Изравняване на блокове при декларация
- Блока с декларациите трябва да бъде подравнен.
- Така ще ни бъде по-ясен.
- Подобните блокове на инициализацията на променливите трябваше да бъдат табулирани.
- ‘&” знака трябва да бъде в близост до типа, а не до името на променливата.
Пример :
var $mDate
var& $mrDate
var& $mrName
var $mName
$mDate = 0;
$mrDate = NULL;
$mrName = 0;
$mName = NULL;
По един израз на ред
Трябва да има само по един израз на ред освен ако изразите са много внимателно свързани.
Документирайте празните изрази
Винаги документирайте празното тяло при for или while изразите така, че да ни е ясно кое и защо е празно, и че сме допуснали умишлено липсата на кода , а не е отсъстващ.
Пример:
while ($dest++ = $src++)
; // празен
Не използвайте подразбиращата се проверка при if за нула
if (FAIL != f())
е по-добро от
if (f())
Тестът дали е нула или не, е често се използва по подразбиране от функции или изрази, които удовлетворяват следващите ограничения :
- Връща нула, което е подобно на неистина
- Изразителното наименуване подсказва какво да очакваме(истина/неистина). Затова ще използваме IsValid(), а не CheckValid().
Булеви типове
Не проверявайте булевите стойност за равенство с 1 (истина, ДА, и т.н.); вместо това тествайте за неравенство с 0 (неистина, НЕ, и т.н.). По-вероятно е повечето функции да връщат 0, ако не е изпълнено условието.
if (TRUE == func()) { ...
трябва да бъдете в този вид
if (FALSE != func()) { ...
Избягвайте вградени присвоявания
Има време и място за вградени присвоявания. В някои концепции има по-добър начин да се постигат резултати без да правим кодът обемист и по-малко четим.
while ($a != ($c = getchar()))
{
преработваме знаците
}
Операторите ++ и -- ще повлияят върху броя на изразите. Което довежда до по-добри резултати във времето за изпълнение на скрипта, но ще намалим възможността за лесна поддръжка.
Пример:
$a = $b + $c;
$d = $a + $r;
Няма нужда да се замени с
$d = ($a = $b + $c) + $r;
Въпреки това последния израз може да спести един цикъл. В крайна сметка разликата във времето за изпълнение ще се намали, докато разликата в лесната поддръжката ще нарасне в случаите, когато човешкият спомен, какво се е случило в последното парче код започва да избледнява.
Документация и коментариКоментари
Коментарите трябваше да разкажат история
Обмислете добре коментарите описващи системата. Очаквайте вашите коментари да бъдат извлечени от роботи и оформени в страница достъпна за човек. Коментарите на класа са една част от описанието, коментарите на методите са друга част, аргументи на методите трета. Всички тези части ще ни помагат и информират, когато по някое друго време се опитаме да разберем точно какво сме правили и защо.
Кога да документираме?
Коментарите трябваше да документират решения. Използвайте коментари във всеки възможен момент, чрез което ще опишете стореното от вас и ще знаете какво сте правили и защо.
Използвайте заглавия
Тези заглавни части са структурирани по такъв начин, че те могат да бъдат анализирани синтактично и извлечени. Те не са безполезни като нормални заглавни части. Така че, вложете времето за да ги опишете. Ако вие го направите правилно, голяма част от алтернативната документация може да бъде избегната.
Подредба на коментарите
Всяка част на проектът има специфична подредба за коментар.
Правете описанието разбираемо
Вградените ключови думи се използуват да описват потенциални въпроси и проблеми. Знайте, че робот ще анализира синтактично вашите коментари търсейки ключови думи и ще ги пренебрегне след изтеглената информация, представяйки я така че да е ясна за хората без голямо опит.
Ключови думи
:TODO: тема
С това отбелязваме неща, които не бива да забравяме или пропуснем
:BUG: [bugid] тема
Ако знаем за някой бъг, тука обясняваме за него и пожелание може да предоставим идентификационния номера на бъга.
:KLUDGE:
Когато правите нещо грозно, кажете това и обяснете как щяхте да го направите ако вие имахте повече време.
:TRICKY:
Казвате, че следващият код е много измамен така че да не се отиват да го променят без сериозно обмисляне.
:WARNING:
Пазете се от нещо.
:PARSER:
Понякога вие трябва да работите върху проблем, който анализирате в момента. Документирайте го. Проблемът може да бъде подминат в края на краищата.
:ATTRIBUTE: стойност
Общата форма за атрибут вградена в коментар. Вие можете да опишете вашите атрибути и те ще бъдат извлечени.
- Ключовата дума трябва да е първа в коментара
- Коментарите могат да се състоят от много редове, но първия ред трябва да съдържа същността - съдържание, смислено резюме.
- Името на автора и датата на забележката трябваше да бъдат част от коментарът. Така може да разберем кога и от кой е прибавен. Вграждането на информация за дата позволява на друг програмист да си направи заключение. Добавянето на автора ни помага да разберем при нужда кой да попитаме.
Пример:
// :TODO: tmh 960810: possible performance problem
// We should really use a hash table here but for now we'll
// use a linear search.
// :KLUDGE: tmh 960810: possible unsafe type cast
// We need a cast here to recover the derived type. It should
// probably use a virtual method or template.
Реализация и интерфейс на документацията
Има две главни аудиенции за документация :
- За обикновени потребители
- За разработчици
С малко предвидливост ние можем да извлечем двата вида на документацията пряко от кода на източника.
За потребители
Потребителите на класата имат нужда от информация за класа и неговия интерфейс. Когато е структурирана правилно може да бъде извлечена пряко от файла. При запълване на заглавната част, коментирайте блоковете за клас, като само включете информация, нужна за програмиста, които използват класът. Не копайте в детайли за реализация на алгоритъм освен ако детайлите са нужни за потребител на класа. Обмислете коментари в заглавната част и ги напишете достатъчно лесно разбираеми за всеки човек.
За разработчици
Този начин на документиране изисква задълбочени познания за клас и неговото приложение. Този вид коментар се съдържа в сорс-файлът. Блокове за коментар на заглавната част в сорс-файл трябваше да покрият въпроси за алгоритмите и възможни други решенията при дизайна. Блокове за коментар в реализацията на метод трябваше да обясняват дори повече.
Документация на директория
Всяка директория трябваше да има файл README, който покрива :
- Предназначението на директорията и това, което тя съдържа.
- Един ред коментар за всеки файл. Може да бъде извлечен от заглавната част на файла.
- Описва пътя на изграждане и инсталиране.
- Насочете хората към взаимно-свързани ресурси :
oДиректории с код
oОнлайн документация
oДокументация на хартия
oДокументация за дизайн
- Каквото и да е, което може да помогне на някой.
Помислете си, че нов човек започва работа върху 6 месечен писан от вас код. Изследователят е сам и уплашен. Той трябва да бъде способен да илюстрира целият проект прекосявайки дървото от директории и четейки файловете README, MAKEFILES и заглавните части на кода. Това може и да сте вие!
ДругиИзползвайте повторно вашата работа и работата на другите
Проектирането на проект е почти невъзможен без използване на структура или начално скеле. Обектите се приспособяват към услугите, налични за тях. Различните проекти имат различни сходни среди за услуги, правещи повторно използване на едни обекти трудно.
Развиването на обикновена структура се нуждае от много опит в началния стадии при изграждането за да работи качествено. Когато този опит не се използва, по произволни причини, има няколко техники, които може да ни насърчат да употребяваме повторно структурите :
Не се страхувайте от малки библиотеки
Това е един от враговете на повторното използване за хората, който не правят библиотеки от техният код. Клас, който може да се използва многократно, ще съществува скрит в програмна директория и никога няма да има възможност да бъде поделен, защото програмистът няма да го разбие на множество класове или класове в библиотека.
Причината за това е че хората не обичат да правят малки библиотеки. Не са прави.Забравете го. Компютърът не се интересува колко библиотеки вие имате.
Ако вие имате код, който може да бъде използван отново и не можете да бъдете поставен в съществуваща библиотека тогава направете нова библиотека. Библиотеките не остават малки за дълго ако хората наистина мислят за повторно използване.
Пазете кода в хранилище
Повечето компании нямат идея какъв код притежават. И повечето програмисти все още не предават това, което те са направили или това, което притежават в момент. Трябва да се поставя всичко налично за момента в хранилището, каквото и да е то.
В идеален свят програмист можеше да отиде към уеб-страница, да прегледа или изследва списък на пакетирани библиотеки, взимайки това, от което има нужда. Ако вие можете да откриете и получите достъп до такава система където програмистите доброволно поддържат, ще е чудесно.
Отворен / затворен принцип
Този принцип казва, че класа трябва да бъде отворен и затворен:
- Отворен значи, че клас има способността да бъде разширяван.
- Затворен значи, че клас е затворен за промени с изключение на разширения. Идеята е, че след като класа е одобрен за употреба минавайки през преглед на кода, тестове на отдела, и др. квалифицирани процедури, вие не желаете да променяте класът повече,а само да го разширявате.
Отвореният/затворен принцип е степен на стабилност. Система се разширява не при добавяне на нов код, а като разширява вече работещия код. Програмистите често не се чувстват спокойно променяйки стар код защото той работи!
В действителност отвореният/затворен принцип просто има предвид добра употреба на абстракция и полиморфизъм. Чрез абстракция разлагаме на части обикновени процеси и идеи. Наследяването ни служи да създаваме интерфейс, който трябва да се придържа към използваните класове.
Сърварна конфигурация
Тази част съдържа някои напътствия за конфигурация на PHP/APACHE.
Разширенията на PHP файловете
Има много различни варианти за разширение на файлове на (.html, .php, .php3, .php4, .phtml, .inc, .class...).
- Винаги използувайте разширението.php.
- Винаги използувайте разширението .php за ваши класове и библиотеки с функции.
Употребата на .inc или .class може да бъде проблем на сигурност. На повечето сървари тези разширения могат да бъдат изключени от анализатора. Ако бъдат достигнати те ще бъдат показани в ясен текст.
Разни
- Не използувайте променливи с плаваща запетая където не е нужно. Винаги тествайте размера на плаваща запетая с < = или > = и никога не използвайте точно сравнение (= = OR! =) за този вид стойности.
- Не разчитайте на автоматични средства, който правят добре изглеждащ код. Програмиста печели най-много от добър програмен стил. Автоматичните средства може да бъдат приложени само за да завършат, синтактично правилни програми. Програмистите могат да свършат по-добра работа при изясняване цялостната зрителна подредба на функции във файл, с нормалното внимание към детайлите на внимателен програмист. Немарливите програмисти трябва да се научат да бъдат внимателни програмисти вместо да разчитат на разхубавяващо средство за да правят техният код четим. Разхубавяващите средства са най-добри за грубо форматиране на кодът, генериран от машината.
- Случаен пропуск на вторият знак ("=") от логическото сравнение е проблем. Следващия пример е объркващ и склонен на грешка.
if ($abool= $bbool) { ... }
Програмистът наистина ли има това на предвид? Вместо това, използвайте ясни тестове и избягва присвояване с безусловен такъв. Препоръчаната форма е да се прави присвояването преди да тестваме :
$abool= $bbool;
if ($abool) { ... }
Използвайте if (0) при разкоментирани блокове с код
Понякога големи блокове код трябва да бъдат разкоментирани за тестване. Най-лесният начин да се направи това, е с един if (0) блок :
function example()
{
Страхотен код
if (0) {
много код
}
Още код
}
Вие не можете да използувате / ** / коментари в този случай, защото коментарите не могат да съдържат коментари и навярно големия блок на вашият код ще се дели на коментари, искате ли го?
PHP тага
PHP тага отделя PHP кода от HTML във файла. Има няколко начини да направите това <?php ?>, <? ?>, <script language="php"> </script>, <% %>, and <?=$name?>. Някои от тези могат да бъдат изключени във вашите настройки на PHP.
- Използвайте този начин - <?php ?>. Той е достъпен във всяка система.
Примери:
?php print "Hello world"; ?> // Ще изведе "Hello world"
<? print "Hello world"; ?> // Ще изведе "Hello world"
<script language="php"> print "Hello world"; </script> // Ще изведе "Hello world"
<% print "Hello world"; %> // Ще изведе "Hello world"
<?=$street?> // Ще изведе стойността на променливата $street
Без магически числа
Така се нарича, защото не можем да разберем по никакъв начин какво означава , когато го видим вътре в скрипта и е включено от авторът.
Пример:
if (22 == $foo) { start_thermo_nuclear_war(); }
else if (19 == $foo) { refund_lotso_money(); }
else if (16 == $foo) { infinite_loop(); }
else { cry_cause_im_lost(); }
В горният пример където са 22 и 19 може ли да разберете какво означават? Ако променим едно от числата или всичките бяха погрешни как вие щяхте да знаете?
Употреба на магични числа определя програмист като аматьор повече от каквото и да е друго нещо. Такъв програмист никога не е работил в екип.
Вместо магически числа използувайте истинско име, описвайки за какво ще се използва или какво съдържа. Може да дефинирате константи.
Пример:
define("PRESIDENT_WENT_CRAZY", "22");
define("WE_GOOFED", "19");
define("THEY_DIDNT_PAY", "16");
if (PRESIDENT_WENT_CRAZY == $foo) { start_thermo_nuclear_war(); }
else if (WE_GOOFED == $foo) { refund_lotso_money(); }
else if (THEY_DIDNT_PAY == $foo) { infinite_loop(); }
else { happy_days_i_know_why_im_here(); }
Сега не е ли това по-добро?
Автор:
Тодор Илиев