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

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


Документация 41

if($month == 'february') {

if($year % 4 == 0 && $year % 100 || $year % 400 == 0) { $days_in_month = 29;

}

else {

$days_in_month = 28;

}

}

Однако это заставляет читающего код помнить порядок приоритета операторов, чтобы правильно понять порядок вычисления выражения. В следующем примере круглые скобки используются для визуального усиления приоритета операторов так, чтобы было проще понять логику:

if($month == 'february') {

if((($year % 4 == 0) && ($year % 100)) || ($year % 400 ==0)) { $days_in_month = 29;

}

else {

$days in_month =28;

}

}

Вместе с тем не следует излишне использовать круглые скобки. Рассмотрим пример:

if($month == 'february') {

if(((($year % 4) == 0 )&& (($year % 100) != 0)) || (($year % 400) == 0 )) {

$days in_month = 29;

}

else {

$days_in_month = 28;

}

}

Выражение перегружено круглыми скобками, и назначение кода трудно расшифровать, как и в примере, который опирается только на приоритет операторов.

Документация

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

Документацию можнЬ разбить на две категории.

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

 API-документация для пользователей, которые намерены использовать функцию или класс без чтения самого кода.

Эти два типа документации описываются в следующем разделе.




  Hostland.Ru

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