yakoffka.ru
грабли, костыли и велосипеды php, css, html, js и прочего

Правила хорошего* кода

правила хорошего кода якава для личного использования

  • 1 при разбиении на части пути к чему-либо при присвоении константам и переменным слэш в каждой части ставим вначале!
    /usr/local/sbin
  • 2 перенос строки ставим в конце строки, отступ - в начале
  • 3 переменные именуем строчными латинскими буквами с нижним подчеркиванием вместо пробелов
  • 4 не ленимся и побольше комментируем код, чтобы меньше напрягаться впоследствии
  • 5 двойные кавычки ставим в php, одинарные - в html и css
  • 6 стараемся убивать переменные сразу после того, как только в них отпадёт надобность
  • 7 проверяем значение переменных строкой, обязательно обрамляя значение переменной кавычками:
    echo __line__.": \$var='$var'<br>\n";
  • 8 прописываем служебные сообщения в виде:
    echo __line__.": директория ".DIR_SRC_CATALOG." создана.<br>\n";
  • 9 прописываем отладочные сообщения в виде:
    if(OUTPUT_MESSAGES){echo "\t".__line__.": создание временного файла '$patch_new_file'.<br>\n";}
  • 10 прописываем ошибки в виде:
    echo "<p class='error'>$name_function error#".__line__."</p>\n"