Limbo cms

Cкачать Limbo CMS

Обновлено 19.01.2012
  • v 1.0.4 RE4 Stable
  • Интернет-маркетинг

    Каталог бесплатных CMS

    Каталог платных CMS

    Главная - Для разработчиков - Стандарт программирования для Limbo

    Стандарт программирования для Limbo

    Настройки редактора

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

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

    Во-вторых, проверьте, чтобы ваш редактор сохранял файлы в формате UNIX (т.е. символом конца строки будет LF). Для этого лучше всего использовать встроенный редактор FAR-менеджер или специальные редакторы для работы с PHP и HTML.

    Соглашения об именах

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

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

    Неправильно:

     

    Правильно:

     

    $currentuser

    $currentUser

     

    $current_user

     

    Но все же есть один случай, при котором возможно использовать переменную из одного символа -  это только в цикле при указании индекса. При этом не забудьте, что  индекс внешнего цикла всегда должен быть $i. Если же внутри цикла присутствует ещё цикл, то имя переменной индекса вложенного цикла будет $j, затем $k и т.д.  Это правило применяется только если в цикле нельзя применить переменную с понятным именем.

    Пример:

    for ($i = 0; $i < $outer_size; $i++)

    {

         for ($j = 0; $j < $inner_size; $j++)

         {

              foo($i, $j);

         }

    }

    При использовании функции, желательно давать ей тоже понятное имя, с символами в нижнем регистре. Лучше всего в имени использовать глагол, например, print_login_status(), get_user_data(), и т.п. По  параметрам функции совпадают с параметрами касающимися переменных.

    И не забывайте соблюдать здравый смысл  и слишком не перегружать имена.

    Оформление кода

    Хочу предложить вам пример стандартного заголовка для новых файлов:

    /***************************************************************************

    * Заголовок скрипта

    * @ Package #package name#

    * @ Copyright (C) 2004 #auther name#

    * @ All rights reserved

    * @ #package name# is Free Software

    * @ Released under GNU/GPL License : http://www.gnu.org/copyleft/gpl.html

    * @ Version #version#

    **************************************************************************/

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

    Неправильно:

     

    Правильно:

     

    if (condition) do_stuff();

     

    if (condition)

        do_stuff();

     

    while (condition)

       do_stuff();

     

    for ($i = 0; $i < size; $i++)

       do_stuff($i)

     

    if (condition)

    {

       do_stuff();

    }

     

    while (condition)

    {

       do_stuff();

    }

     

    for ($i = 0; $i < size; $i++)

    {

       do_stuff();

    }

     

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

    Например: 

    if (условие)

    {

       while (условие2)

       {

          ...

       }

    }

    else

    {

       ...

    }

     

    for ($i = 0; $i < $size; $i++)

    {

       ...

    }

     

    while (условие)

    {

       ...

    }

     

    function do_stuff()

    {

       ...

    }

     

    Не забывайте, что после каждого слова надо ставить пробелы, это сделает код более читаемым. Например,

    Неправильно

    Правильно

    $i=0;

    if ( ($i < 7)&&($j > 8) ) ...

    do_stuff( $i, "foo", $b );

     

    $i = 0;

    if (($i < 7) && ($j > 8)) ...

    do_stuff($i, "foo", $b);

     

    if($i<7) ...

    for ($i=0; $i<$size; $i++) ...

    $i=($j < $size)?0:1;

     

    if ($i < 7) ...

    for ($i = 0; $i < $size; $i++) ...

    $i = ($j < $size) ? 0 : 1;

     

    Важно также подчеркивать старшинство операторов, применяя при этом скобки:

    // Кто знает какой будет результат?

    $bool = ($i < 7 && $j > 8 || $k == 4);

    // Здесь результат очевиднее

    $bool = (($i < 7) && (($j < 8) || ($k == 4)));

    На что еще следует обратить внимание, так это вид SQL-кода. Используйте скобки и регистры. Например,

    SELECT field1 AS something, field2, field3

       FROM table a, table b

       WHERE (this = that)

           AND (this2 = that2)

    Общие рекомендации

    1. Используйте строковые переменные. Для этого возможно использовать текстовые строки в PHP - с одиночными кавычками или с двойными при этом  одиночные кавычки используйте только если вы точно знаете, что преобразования не нужны. И это позволит вам увеличит скорость выполнения скрипта. Учтите, что используя строковую переменную в качестве параметра функции не применяйте кавычки, отягощая при этом работу синтаксическому анализатору PHP. Пример:

    Неправильно:

     

    Правильно:

     

    $str = "This is a really long string with no variables for the parser to find.";

    do_stuff("$str");

     

    $str = 'Thisisareallylongstringwithnovariablesfortheparsertofind.';

    do_stuff($str);

     

     

    1. Ассоциативные ключи массива. Например:

    Неправильно:

     

    Правильно:

     

    $foo = $assoc_array[blah];

     

    $foo = $assoc_array['blah'];

     

     

    1. Комментарии. Все комментарии должны подчиняться правилу:

    // Комментарий начинается с большой буквы и без точки в конце

    1. Сокращенные операторы. Единственные сокращенные операторы, которые осложняют читаемость кода - это прибавление/инкримент ($i ++) и вычитание/декримент ($j-), поэтому они не должны использоваться как часть выражения. Хотя и могут использоваться в таком случае, когда они стоят на отдельной строке. Например:

    Неправильно:

     

    Правильно:

     

    $array[++$i] = $j;

    $array[$i++] = $k;

     

    $i++;

    $array[$i] = $j;

     

    $array[$i] = $k;

    $i++;

     

     

    1. Встраиваемые условия. Эти условия должны использоваться только для действий присвоения и никак не  для функциональных запросов и т.п. Например:

    Неправильное использование:

     

    Правильное:

     

    (($i < $size) && ($j > $size)) ? do_stuff($foo) : do_stuff($bar);

     

    $min = ($i < $j) ? $i : $j;

     

     

    1. Неинициализированные переменные. Во избежание ошибок используйте функцию isset () во время выполнения скрипта (E_ALL). Эта функция выполняет проверку - была ли эта переменная инициализирована. Например:

    Не корректно:

     

    Правильно:

     

    if ($forum) ...

     

    if (isset($forum)) ...

     


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

    Copyright © 20.01.2005-19.09.2017 русская поддержка Limbo CMS.