Профессиональное программирование на PHP

Страница 36 из 591


38 Глава.: 1 Стили кодирования

■ многословные имена классов должны представлять собой одно слово, а первые буквы всех входящих в имя слов должны вводиться в верхнем регистре (то есть с использованием венгерской нотации).

Ниже приводится два примера объявления классов, которые иллюстрируют данное соглашение.

class XML_RSS {}

class Text_PrettyPrinter {}

Имена методов

Java-стиль в данном случае заключается в соединении слов, входящих в имя метода, и использование верхнего регистра для всех слов, кроме первого (венгерская нотация), см. пример ниже:

class XML RSS {

function startHandler() {}

}

Согласованность имен

Переменные, которые используются для сходных целей, должны иметь подобные имена. Код, подобный приведенному ниже примеру, демонстрирует крайнюю степень несогласованности.

$num_elements = count($elements); $objects_cnt = count($objects);

. Если выбрана одна схема именования, то нет необходимости просматривать код, для того чтобы убедиться, что используется правильное имя переменной. Ниже перечислены другие распространенные уточняющие спецификаторы, которые можно использовать в качестве стандартных:

$max_e1ement s; $min_elements; $sum_elements; $prev_item; $curr_item; $next_item.;

Соответствие имен переменных именам полей в базе данных

Имена переменных, которые связаны с записями базы данных, всегда должны иметь согласованные имена. Ниже приводится пример хорошего стиля именования переменных; все имена переменных точно соответствуют именам столбцов в базе данных:

$query = "SELECT firstname, lastname, employee_id

FROM employees"; $results = mysql_query($query);

while(list($firstname, $lastname, $employee_id) = mysql_fetch_row($results)) { // ...

}

Использование альтернативных или коротких имен переменных вводит в заблуждение и усложняет сопровождение кода.




  Hostland.Ru

 «Бесплатный хостинг Hostland.Su» © 2006