Давайте тут собирать правила хорошего кода.

Например:
1. Не писать код работающий только с register_globals on. Вместо этого использовать $_GET[''] и $_POST['']
2. Не называть функции непонятными для посторонних именами
3. Делать комментарии в коде, чтобы можно было легко разобраться в нем.

4. Отступы.
5. Минимум переменных необходимых для решения задачи.
6. У функций return
7. Вывод гипертекста - один раз.

8. Отделение ввода данных в базу от вывода гиперетекста

Цитата(HalkaR @ 3.4.2005, 00:02)

8. Отделение ввода данных в базу от вывода гиперетекста

Я бы сказал: " отделение всего кода от вывода ьгипертекста". По сути шаблоны. Что скажешь?

Кстати говоря насчет вывода текста один раз не могу согласиться - это неправильно.

Цитата(yUAC @ 3.4.2005, 03:14)

Кстати говоря насчет вывода текста один раз не могу согласиться - это неправильно.

Почечму?
Во-первых отпадает (практически) трабла с заголовками и установкой куков.
Во-вторых существенно увеличиваетс производительность скрипта.
В третьих это более грамотно с точки зрения проектирования, т.к. в случае чего можно пройтись по всему гипертексту.

9. Краткость сестра таланта.
Пример:

Код

<?php // Есть у нас такой кусок кода: if($a == 1) {    $b = $a; } else {    $b = 2; } // Можно сократить до: $b = ($a == 1) ? $a : 2; ?>

10. Оптимизация строковых функций.
Пример:

Код

<?php // Замена переменных в шаблоне $text = ereg_replace("<!--a-->", $a, $text); $text = ereg_replace("<!--b-->", $b, $text); $text = ereg_replace("<!--c-->", $c, $text); $text = ereg_replace("<!--d-->", $d, $text); // Это по меньшей мере ужасно, но встречается очень часто.  // Оптимизируем и получаем одну строку: $text = str_replace(array('<!--a-->', '<!--b-->', '<!--c-->', '<!--d-->'), array($a, $b, $c, $d), $text); // Разбивка текста всегда осуществляем с помощью explode, // а не split'a как это очень часто делают некоторые неопытные люди. Т.е. такой код: $arr = split("|", $line); // Заменяем на  $arr = explode("|", $line); // Разумеется если вам необходимо разбить строку при помощи регулярных выражений, // лучше всего сначала подумать: а может быть есть другой выход из ситуации? ?>

PS Пока все.

Цитата(Mal @ 2.4.2005, 23:12)

Цитата(HalkaR @ 3.4.2005, 00:02) 8. Отделение ввода данных в базу от вывода гиперетекста Я бы сказал: " отделение всего кода от вывода ьгипертекста". По сути шаблоны. Что скажешь?

Полностью отделить код от html очень тяжело, но естественно желательно. Я просто более мягко сформулировал.

Слишком четкое отделение РНР кода от HTML приведет скорее всего к тому что появится еще один интерпретируемый язык, что приведет к большому снижению производительности.

http://pear.php.net/manual/en/standards.php

Irokez
это правила составления PEAR.

Mal Hack ну да я знаю ... а он на чем пишется? на пхп ...
по-моему стандарты написания пеар пакетов стоит взять за стандарты написания всех пхп скриптов ...

Irokez
я к тому, как бы что там описывается схема структура файла PEAR

Mal Hack
так пеар файл и есть ни что иное как грамотно написанный пхп скрипт,
и по ссылке описываются как такой скрипт грамотно написать (в плане синтаксиса)

Цитата(Irokez @ 7.4.2005, 21:20)

так пеар файл и есть ни что иное как грамотно написанный пхп скрипт,

не факт. Многие считаю его тяжелым

Цитата(Irokez @ 7.4.2005, 21:20)

и по ссылке описываются как такой скрипт грамотно написать (в плане синтаксиса)

Я имею ввиду (может и ошибаюсь) имел ввиду что класс должен называться так-то, сожеражть обязательно определенные свойства и методы..

Mal Hack
да нет там такого:

Цитата

Chapter 4. Coding Standards

стандарты написания кода, а не класса, т.е. как правильно код написать

Звиняй, не прав я был. Раньше этого не замечал.

звиняю

можно так же писать все константы прописными буквами - это как общепринятное правило уже стало

Цитата(IZ @ 3.4.2005, 10:58)

10. Оптимизация строковых функций. Пример: Код <?php // Разбивка текста всегда осуществляем с помощью explode, // а не split'a как это очень часто делают некоторые неопытные люди. Т.е. такой код: $arr = split("|", $line); // Заменяем на  $arr = explode("|", $line); ?>

Split и Explode две совершенно разные функции. И утверждать что тот кто использует Split - неопытный человек, полный бред. ;)

Илья
чаще всего так... обычно split приименяют необоснованно..

Илья, есть куча примеров, хотя бы на данном форуме А еще знаю человека который преподает в неком учебном учреждении, на платной основе, РНР, что такое explode он незнает

Я сколько не делал всевозможных скриптов, ну нигде я не нашел применения этой функции

IZ@TOP
explode не приходилось юзать?

Ринат, прочти тему с начала, потом разбегись и ... об стену - разбег 100 метров

Я считаю, отделение логики от гипертекста - совсем не в тему.
Топик создавался для сбора примеров правил хорошего кода.

Со своей стороны могу подчеркнуть некоторые моменты, которых я придерживаюсь:

таб - пробелами, 4 символа
класс - имя класса и его конструктора с большой буквы, верблюжьим стилем ( ExampleClass() )
методы - с маленькой, верблюжьим стилем ( theMethod() )
переменные - в основном с маленькой буквы, через подчеркивание ($the_variable)
фигурные скобки - ВЕЗДЕ(!) в одной строке с оператором/функцией/итд... пример

Код

function a(){     if($z){         $a=1;     } else {         $a=0;    } }

документирование кода - ОБЯЗАТЕЛЬНО! все классы, их методы, переменные...
константы - большими буквами
дефайны - тоже.
в строках, при использовании переменных, обязательно выделяю их вот так

Код

$str="Hello ".$name."! I see you!";

require/include - в скобках. это больше для красоты. require_once("MyClass.php");

А вот чего никак не возьму в привычку, так это пробелы вокруг знака =


Это сообщение отредактировал(а) Alone - 6.10.2005, 10:34

Мне нравятся упрощенные конструкции условий использовать:

Код

$a = (is_numeric($b)) ? $b : 0;

Добавлено @ 13:54
А в остальном полностью поддерживаю Alone, ну, за исключением пробелов, я вставляю до и после знака =.

Полностью согласен с Alone, делаю почти один в один. Единственное исключение, так это

Код

function a() {     if($z)     {         $a=1;     }      else //Любая { или } на отдельной строке     {         $a=0;     } }

Исключительно ради наглядности
Ну и в обязательном порядке пробелы вокруг = + - * / & && | || == != > < >= <=

IZ@TOP
Да мне тоже нравятся упр констр, но не все их понимают.
Если для себя - можно, а если для кого-то?

Коментировать каждую функцию, что делает, что на входе, что на выходе.
Созавать в каждом классе пример использования (закоментированый)

+ ко всему... Не знаю относится это к правилам хорошего кода, но что правила - точно.
не объединять при выводе длинные строки, время выполнения увеличивается
Т.е.

Код

echo $str1.'fghgfh'.$str2; //аналогично print("$str1 sdgfsdgdsg $str2"); //заменяем на echo $str1; echo 'fghgfh'; echo $str2; print("$str1 sdgfsdgdsg "); print($str2);

забыть про exec и system!

Цитата(Bikutoru @ 10.10.2005, 16:57)

Ну и в обязательном порядке пробелы вокруг = + - * / & && | || == != > < >= <=

Так некоторые умудряются еще и пробелы вокруг . ставить

Код

$str = "str" . $a . "str"; $str = "str".$a."str"; // я придерживаюсь такого стиля

Цитата(IZ @ 10.10.2005, 13:49)

А в остальном полностью поддерживаю Alone, ну, за исключением пробелов, я вставляю до и после знака =.

Я не хочу сказать что это излишне, я просто еще сам не привык везде ставить пробелы вокруг =
Тоесть правилом хорошего кода я это как раз считаю

А вдополнение ко всему сказанному я бы рекомендовал пользоваться ZDE
Умопомрачительная девелоперская среда! Подойдет как профессионалу, так и начинающему.
Главное не кипятиться при первых попытках работы с ней.
Да она тяжеловесная, потому как писана на яве, но в этом есть смысл. Но по своему удобству / функциональности она превосходит все остальные продукты, коих можно на пальцах перечислить.
Чего только стоит CodeCompletion! При обращении к объекту показывает все его методы и переменные.
А phpDocumentor! Если у вас в привычке есть пунктик - документировать все классы/методы/прочие_функции, то создание хтмл варианта документации разработчика состоит из 2-3 кликов.
В общем вот такие вот дела Если бы еще зенд покашлял немного денег мне за рекламу его продукта - я был бы счастлив

А по мне, так удобнее (и красивее) пользовать Pear стандарты:

Код

function NameFunction() { // у функций скобы такие     if ($z) { // а у конструкторов такие         $a = 1;     } else {         $a = 0;     } } switch ($var) {     case ("bla"):         $m = 0;         break;     case ("alb"):         $m = 1;         break; } // Классы аналогично функциям class NameClass {     function NameFunction()     { // у методов скобы такие         if ($z) { // а у конструкторов такие             $a = 1;         } else {             $a = 0;         }     } }

Это сообщение отредактировал(а) -=Ustas=- - 19.10.2005, 14:19

Есть некоторые люди, которые ещё и дополнительный перенос строки ставят... )))

Цитата(AntonioBanderaz @ 24.10.2005, 13:36)

Есть некоторые люди, которые ещё и дополнительный перенос строки ставят... )))

Т.е.?

всем хай

Цитата

<?php // Замена переменных в шаблоне $text = ereg_replace("<!--a-->", $a, $text); $text = ereg_replace("<!--b-->", $b, $text); $text = ereg_replace("<!--c-->", $c, $text); $text = ereg_replace("<!--d-->", $d, $text); // Это по меньшей мере ужасно, но встречается очень часто. // Оптимизируем и получаем одну строку: $text = str_replace(array('<!--a-->', '<!--b-->', '<!--c-->', '<!--d-->'), array($a, $b, $c, $d), $text); // Разбивка текста всегда осуществляем с помощью explode, // а не split'a как это очень часто делают некоторые неопытные люди. Т.е. такой код: $arr = split("|", $line); // Заменяем на $arr = explode("|", $line); // Разумеется если вам необходимо разбить строку при помощи регулярных выражений, // лучше всего сначала подумать: а может быть есть другой выход из ситуации? ?>

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

Код

<?php // Замена переменных в шаблоне $text = ereg_replace("<!--a-->", $a, $text); $text = ereg_replace("<!--b-->", $b, $text); $text = ereg_replace("<!--c-->", $c, $text); $text = ereg_replace("<!--d-->", $d, $text); // Это по меньшей мере ужасно, но встречается очень часто.  // Оптимизируем и получаем одну строку: $text = str_replace(array('<!--a-->', '<!--b-->', '<!--c-->', '<!--d-->'), array($a, $b, $c, $d), $text); // Разбивка текста всегда осуществляем с помощью explode, // а не split'a как это очень часто делают некоторые неопытные люди. Т.е. такой код: $arr = split("|", $line); // Заменяем на  $arr = explode("|", $line); // Разумеется если вам необходимо разбить строку при помощи регулярных выражений, // лучше всего сначала подумать: а может быть есть другой выход из ситуации? ?>

Это сообщение отредактировал(а) Master - 24.10.2005, 16:21

Цитата

Т.е.?

Код

class tralaLA {      var $tra;      var $rara;      function tralaLA() {                    //некоторые действия          // Тоже действие          //Etc...      } }

Добавлено @ 13:53
Если что пример могу скинуть в виде ссылки...

AntonioBanderaz, жуть!!! Хоть и отступы есть, а читабельность нулевая!

Да я и сам испуг когда эт увидел...

Я лично при кодинге больших "приложений", предпочитаю пользоваться следующим:

По моему это лучший вариант для более удобного парсинга своего же кода в будущем!
А то будет в коде куча {{{{{{{ и }}}}}}}} и попробуй разберись что к чему относится, а так все четко и понятно!

Это сообщение отредактировал(а) wsr - 23.1.2006, 01:08

Позвольте, отделение пробелами - увеличивает читабельность, имхо...
1.

Код

if($a == "test") {       echo "Test is: " . $a . "!"; }

2.

Код

$at = Array(); $ar = Array( Array() ); echo $ar[ $at[0] ][0];

wsr, мне кажется что эти конструкции немного устарели. А с фигурными скобками разбираться нет проблем - ставим Zend Studio и радуемся крестикам которые эти скобки группируют (скрывают, открывают).

Изотоп, умм... вы меня извините, конечно, но зенд стоит 99-1499 баков стоит Но это так, к слову...
А вообще, хорошо оформленный код избавляет от проблемы различения '}'.
Свёртывание кода, имхо, вообще не должно влиять на удобочитаемость кода.
Да, и, кстати, насколько я помню комодо тоже свёртывает неплохо.

Kefir, кто чем пользуется. Я привык к зендовскому монстру, стоит да, но я пока "триал" юзаю (хи-хи). Правильно ты сказал - как напишешь, так и прочитаешь.

Многие редакторы могут сворачивать блоки (кажется, это называется "фолдеринг" или что-то типа этого). Например, Notepad++. Он к тому же идет под GNU GPL.

ЗЕНД тоже с 5 версии сворачивает.

Тут говорилось о том, что он платный и я предложил бесплатную альтернативу.

Где-то читал, что:
echo "My name is $name!";
Намного быстрее чем
echo "My name is".$name."!";
И быстрее чем:
echo "My name is {$name}!";

Быстрее но не значит лучше!
В дальнейшем, при парсинге кода гораздо легче в большом блоке данных найти echo "My name is".$name."!"; чем echo "My name is $name!";

Самое быстрое и лучше - второй вариант, затем третий, затем первый.

Я вот юзаю такой синтаксис:
1) если PHP-код идёт блоками с (X)HTML-кодом, то делаю так:

2) если есть какие-то структурированные массивы, то описываю их структуру в комментах:

3) отделяю некие псевдо-блоки кода, которые являются одной частью:

4) комментарии начинаю с большой буквы, если они находятся в новой строке, иначе — с маленькой. Выравниваю комменты, если они находятся в ближайшей видимости:

5) отделяю пробелами символы операций (меньше, больше, присвоить значений и т.д.)
6) отделяю важные блоки так:

7) описываю новые элементы с новой строки при определении массивов, но только если это логично для данных массива:

8) функции описываю так:

9) для отступов юзаю табы в размере 4 знакоместа
10) строки с использованием переменных разбиваю:

11) там, где не нужна обработка escape-последовательностей, юзаю одинарные кавычки для строк, иначе — двойные:

12) пишу код, который не зависит от register_globals, чем [новички (не все); люди которые не беспокоятся о безопасности; ленивые (которым пофигу); возможно ещё есть кто-то, кого я не включил в этот список] зачастую пренебрегают... а жаль
13) пишу в EditPlus, хотя как-нить обязательно прикуплю диск (конечно не лицензионный, денег таких нет, чтобы разбрасываться ими на такое добро) с Zend-ом

ЗЫ: кстати описывание комментариев по PEAR стандартам отличается в русской и английской доке:
ru: http://pear.php.net/manual/ru/standards.header.php
en: http://pear.php.net/manual/en/standards.header.php
Мне больше нравится так, как в английской доке

Это сообщение отредактировал(а) Ciber SLasH - 20.1.2006, 09:50

Читал, что лучше использовать одинарные кавычки+конканетация переменных.

Так и есть. В этом случае не тратится лишнее время на разбор строки.

Видимо из тех соображений, что парсер не тратит время, выискивая переменные в двойных кавычках.

Это сообщение отредактировал(а) DENNN - 20.1.2006, 13:07

Да, так было до 5-ой версии PHP, в 5-ой теперь обрабатывается одинаково быстро.

5-я версия, это конечно хорошо, но к великому сожалению большинство хостингов сидят на 4-ёрке.

Помоему сейчас тема с кавычками не особо актуальна, так как рано или поздно, но все равно все перейдут на PHP 5.
А там как известно "все" одинаково. ИМХО.

Правила написания PEAR рулят однозначно!!!
Код получается красивый, понятный, быстрый и самодокументирующийся (PEAR::phpDocumentor)

Мне PEAR не нравятся... Больше нравится такой стиль:

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

Не совсем согласен. У каждого прогера свой стиль программирования. Люди все разные... клоны пока не получили широкого распространения

Я тоже в таком стиле люблю писать. Занимает мало места и для меня - очень наглядно

Аналогично

Если встерчается конструкция из более чем 2х циклических вложений - это уже повод задуматься о декомпозиции...

Это сообщение отредактировал(а) Alone - 2.3.2006, 10:37

Стандарты в любом случае должны быть! Т.к. вольное программирование - как кому нравится, становится трудным в сопровождении кода другими программистами! Личный пример: полгода назад принял некоторый проект на поддержку, так я того прогораммиста готов завалить при первой же встрече!!!!!!!!

Это сообщение отредактировал(а) -=Ustas=- - 2.3.2006, 10:42

Меня просто в дрошь кидает, когда вижу такое:



Не красиво до ужаса, вот } else { совсем другое дело ;)

Стандарты пиар у руля!!! По-любому!

для такого случая я использую


а вобще


И что тут такого ужастного?? Все наглядно и понятно.

Я помню когда сам писал так давно на С. У нас в универе сначала преподавали Pascal и он мне понравился до безумия. Ну и там как раз блоки операторов отделяются так:

и когда после Pascal-я начали учить C, то я старался придерживаться той структуры кода, как в Pascal-е, т.е. писал так:

но потом от такой структуры отказался, т.к. код сильно расплывается из-за лишних переводов строк. И в итоге мне приглянулась такая структура:

Кому что. Мне больше с отступами нравится

Мне тоже не нравятся стандарты PEAR.

Сам делаю так:
Имена переменных: все буквы маленькие, слова разделяю "_".
Имя классов: Каждое слово с заглавной буквы. Без "_".
Имя методов, функций - аналогично названию класса. Приватный метод: вначале "_".
Название свойств: первое слово с маленькой буквы, остальные слова с большой. Без "_".
Все отступы делаю табуляцией.

Пример:

А я так пишу:

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

Может кто писал уже, не знаю ...

Вот такой код:

я всегда стараюсь записывать так:


Еще пример:

заменяю на


Разумеется, речь идет о одностроковых действиях в блоках if-else.

А кто сказал, что PEAR - это эталон? Если нашлось достаточно большое количество противников такого подхода, то что-то неладно с этим стандартом. Я сам сторонник стандартов, но стандарты, которые усложняют коммуникативность должны быть изменены, ИМХО.
Когда приходится рефакторить огромное количества кода, то начинаешь плеваться от такой размазанности, т.к. страдает визуальное восприятие. Ведь код должен не только работать, но и читаться.

Я всеми руками за конструкцию:



В коде: смысловые блоки компактны, четко выделены узлы ветвления, при этом отражено направление ветвления визуально (что страдает у PEAR-а).

Мне все больше нравятся тсандарты PEAR. Так, пересмотрев справочник я нашел там вот такие вещи:



Чем вам не нравится данный подход?
Добавлено @ 13:13
Основные выдержки из мануала:



Оформление оператора if:



Оформление оператора switch:



Объявления переменных, выхов функции:




Объявление функций: