Статьи,обзоры,справочники по PHP

       

Недостаточно либо излишне комментированный текст


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

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

<?php // Начало кода

$age = 18; // Возраст равен 18

$age++; // Увеличим$age на один год

// Напечатаем приветствие

print "Вам сейчас 19 лет, и это значит, что Вам уже было:"; print "\n<br>\n<br>\n";

// Цикл ‘для’ чтобы вывести все // предыдущие значения возраста

for ($idx = 0; $idx < $age; $idx++) { // Напечатаем каждое значение возраста

print "$idx лет\n<br>\n"; } // Конец кода

?>



Содержание раздела