21 ошибка программиста php

Следует также избегать избыточных комментариев. Это тоже встречается очень редко, и, опять же, создает трудно читаемый исходный код. Следующий пример это иллюстрирует:
n
n"; // Цикл ‘для’ чтобы вывести все // предыдущие значения возраста for ($idx = 0; $idx <$age; $idx++) { // Напечатаем каждое значение возраста print "$idx летn
n"; } // Конец кода ?> И все-таки: где золотая середина?

Итак, какой же объем комментариев следует помещать в скрипт?! Это зависит от многого: от времени, которым вы располагаете, от политики компании, сложности проекта и т.д. Тем не менее, запомните несколько основных принципов, которым надо следовать при написании программ вне зависимости от вашего решения:
Перед телом функции всегда помещайте комментарий – назначение функции. Добавляйте комментарии в сомнительных участках кода, когда нет уверенности, что он будет работать как надо. Если назначение кода неочевидно, внесите информацию о предназначении этого участка. Вы же потом воспользуетесь этим комментарием. Избегайте комментарии вида # - используйте только /* */ либо //.

Следующий пример иллюстрирует хороший стиль комментариев:
18. Слишком много переменных - слишком большое время выполнения

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15

Другие голосования

Приглашаем Вас обменяться кнопочками! Обращайтесь к администратору.

• установка php и apache на *nux
• собираем apache + php + xml для linux
• синтаксис .htaccess
• модуль mod_rewrite. часть 4
• модуль mod_rewrite. часть 3
• модуль mod_rewrite. часть 2
• модуль mod_rewrite. часть 1
• Apache + php + xml + mysql для windows
• вебсервер в домашних условиях
• протокол hdlc