Много хора слагат знак за равенство между програмиране и писане на код. Склонни сме обаче да спорим, че знакът за равенство трябва да бъде поставен между програмиране и писане на четивен код.

Три съвета за по-четивен код

Съществуват множество съвети за това как да подобрите качеството на написания код; авторите Дъстин Босуел и Тревор Фучър са ги събрали в изчерпателната книга "Изкуството на разбираемия код". Днес обаче ви предлагаме три лесно-приложими съвета, за да започнете да пишете по-четивен код още от този момент.

Смислени коментари

Коментарите са от изключително значение. Ако за момент си помислите, че не са ви необходими, замислете се отново - какво би се случило, ако се върнете да прочетете своя код след месец, без да сте поставили нито един коментар. А след година?

Разбира се, това далеч не означава, че е необходимо да коментирате всеки ред от програмата си. Когато кодът е праволинеен, например,

// получава кода на държавата
$country_code = get_country_code($_SERVER['REMOTE_ADDR']);
// ако кодът е US
if ($country_code == 'US') {
    // визуализира специфична информация
    echo form_input_state();
}

е достатъчно да поставите само един коментар в началото:

// визуализира информация за потребители от US
$country_code = get_country_code($_SERVER['REMOTE_ADDR']); 
if ($country_code == 'US') {
    echo form_input_state();
}


Описателни имена на променливи

Изборът на подходящи имена на променливите е също толкова важен, колкото и поставянето на коментари на правилните места. Имена като $k, $m и $test не носят никаква допълнителна информация в себе си. С времето е сигурно, че ще забравите какво точно сте имали предвид с променливата $k. По-добър избор биха били имена от типа $request (за съхранение на заявка), $dbResult (за съхранение на резултат от база данни) и $tempFile (за временно съхранение на файл).

Постоянство в стила на писане

Поставянето на отстъпи в кода е задължително условие за четивността на вашата програма. Това, което много начинаещи програмисти пропускат, е, че отстъпите трябва да следват един и същ стил на изписване, особено когато става въпрос за местоположението на отварящите и затварящи скоби. Ето трите основни стила, измежду които можете да избирате:

Три съвета за по-четивен код

Кой от тези стилове ще предпочетете е въпрос на личен избор. Ако обаче сте част от екип, препоръчително е да се придържате към установените практики на останалите членове на екипа. За любопитните, в Wikipedia има доста обширна статия за различните стилове (на английски).