Грабля 3. Стиль программирования

Грабля 3. Стиль программирования

    У каждого программиста должен быть свой стиль программирования. Это такие вещи как:

• отступы;
• расположение скобок составного оператора;
• комментарии;
• описание каждого модуля (исх. файла) программы;
• пробел между арифметическими операторами (+, -, *, ., = и т.д.);
• имена переменных, констант, функций, классов и самих исходных файлов
• список можно продолжить в зависимости от вашего текущего уровня.

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

    Что касается пробелов и отступов, то тут конечно дело вкуса но конструкции вида:



$var=((54-89)/((45+54)*4)-5);

просто взрывают мозг, особенно когда они встречаются во всем коде попробуй-ка разбери. Глазки режет?

$var = ((54 - 89) / ((45+54) * 4) - 5);

Так-то лучше. Да кстати результат выражения будет -5.088(38) :S.

    Помимо комментариев в коде желательно в самом начале исходника расположить название и краткое описание этого Исходника. Требуется описать, для чего он предназначен, какие функции содержит с их кратким описанием. Это позволит вам (и не только) в будущем, просмотрев только начало файла, уже знать для чего сей "сырец" и какие функции тут есть.

    Имена нужно давать осмысленные. Никаких там $var1 $var2 file1.php file2.php. Это все высер а не имена. Они должны определять что там в файле, что там храниться в переменной, что это за функция. Например, $count, $page, $is_required и т.д. Имена так же как и комментарии способствуют лучшему восприятию исходного кода. Желательно имена давать на английском языке. Так что те кто знает инглиш находятся в более выигрышном положении, особенно если код написан не ими, а кем-то из-за бугра. 

    Ставить скобки можно так

if(условие) {
    // код
} else {
    // код
}

или так

if(условие)
{
    // код
}
else
{
    // код
}

Это два наиболее распространенных способа оформления составного оператора. Выберите то что вам по душе.

Вот так. Будьте стильными :)