Рекомендуемые правила оформления кода

[Sna1L]

Простая истина: пишите так, чтобы другой человек мог это понять. Как именно вы это будете делать - неважно. Главное результат, а не метод

А то развели тут понимаете ли, "скобочки олмана", "скобочки кернигана/ритчи"...)))

[ds.Dante]

Вот моё руководство по стилю:
1) Прочитать "Совершенный код", чтобы сформировалось понятие о плюсах и минусах разных стилей. Читать побольше разных open source, чтобы сложилось представление о сложившихся практиках.
2) Забить на формальности, программировать так, как наиболее удобно (читаемо, изменяемо, расширяемо) в данном конкретном случае. Руководствоваться при этом общими правилами из предыдущего пункта.
3) При работе в команде избегать соблазна менять стиль чужого кода. Свой код писать в своём стиле (по предыдущим двум пунктам), но при этом учиться работать с кодом, написанном в любом стиле.

[Lesha]

Сообщение от Bustle

Как документировать код
Стиль:
- Табуляция 4 пробельных символа (именно пробельных символа, а не знак табуляции)
- Примеры оформления:

if ($xX === 1)
{
    // делаем что-то
    $yY = myFunc($Xx);
}
else
if ($xX === 2)
{
    // делаем что-то
}
else
{
    // делаем что-то
    $xX = myFunc(1, 3, 4, 10, 'hello');
    if ($xX == 1 && $yY == 'world')
    {
    }
}

function myFunc($Vv)
{
    $aA = array($vV);
    foreach($aA as $kK => $vV)
    {
        // что-то делаем
    }
    switch($aA)
    {
        case 1 :
        {
            break;
        }
        case 2 :
            break;
    }
}

- Желательно писать как можно короче
- Стараться умещать строку кода по ширине до 80 символов, на крайний случай до 120
- Названия переменных, классов, функций, методов и т.п. должны отражать суть, но не быть слишком длинными и не слишком короткими

я почемуто думаю что перенос {} на одельные строки плохо сказывается на читаемости кода

думаю такой "стандарт" лучше
также для повышения вимости где что кончается можно комментировать закрывающие скобки (end foreach | end switch и тп)

<?php
// укороченный {} стиль

if ($xX === 1) {
    // делаем что-то
    $yY = myFunc($Xx);
} else if ($xX === 2) {
    // делаем что-то
} else {
    // делаем что-то
    $xX = myFunc(1, 3, 4, 10, 'hello');
    if ($xX == 1 && $yY == 'world') {
    }
}

function myFunc($Vv) {
    $aA = array($vV);
    foreach($aA as $kK => $vV) {
        // что-то делаем
    } // end foreach
    switch($aA) {
        case 1 : 
			// действия
        break;
	case 2 : 
			// действия
        break;
    } // end switch
} // end function

[Naive]

Сообщение от Lesha

я почемуто думаю что перенос {} на одельные строки плохо сказывается на читаемости кода

думаю такой "стандарт" лучше
также для повышения вимости где что кончается можно комментировать закрывающие скобки (end foreach | end switch и тп)

<?php
// укороченный {} стиль

if ($xX === 1) {
    // делаем что-то
    $yY = myFunc($Xx);
} else if ($xX === 2) {
    // делаем что-то
} else {
    // делаем что-то
    $xX = myFunc(1, 3, 4, 10, 'hello');
    if ($xX == 1 && $yY == 'world') {
    }
}

function myFunc($Vv) {
    $aA = array($vV);
    foreach($aA as $kK => $vV) {
        // что-то делаем
    } // end foreach
    switch($aA) {
        case 1 : 
			// действия
        break;
	case 2 : 
			// действия
        break;
    } // end switch
} // end function

Согласен, тоже использую "египетские скобки" в своем коде. Особенно "не-египетское" оформление замусоривает православный JavaScript, когда выходят цепочки кол-бэков на 40-50 вложенностей.

[the_deer_one]

Меня заставили поставить решарпер.
И вот он помимо очевидных преступлений против стилистики, подчёркивает локальные объявления вида.

Stopwatch sw = new Stopwatch();

Говорит что это use implicitly typed local variable declaration.

Явное указание типа, это нынче некошерно что ли?

[pproger]

2the_deer_one
видимо в языках с выводом типов это уже является плохим тоном.

auto sw = new Stopwatch();

но

Stopwatch sw = getStopwatch();

[crazy horse]

Египет/не египет - споров масса, но лично мне удобнее в редакторе находить пары скобок на одной линии, а не искать где там в какой строке в конце половинка затерялась, особенно, если их под 50 (половинок). Не надо мата на тему "столько не надо, бейте на функции", это пройденный этап. В геймдеве оптимизация решает и часто приходится делать именно так. И подсветка тут мало помогает.