в настоящий момент я пишу сайт для 1-го игрового сервера. это http://la2.multi-net.ru/. Визуальное оформление текущего сайта ужасно, но php код оказался еще более ужасен. В нем нет абсолютно никакой структуры, порядка, код почти не документирован(без комментов), а если и есть комменты, то они наполовину на русском, наполовину на англ, в этом коде черт ногу сломит. Кроме того, изначально, пока я их не тыкнул, у них полностью отсутствовала какая либо защита от sql инъекций.
Поскольку до этого я писал на C#, одна из идей которого является - полностью ООП, сайт по привычке тоже решил писать в ООП стиле. Сегодня 1 из заказчиков постучался в асю и спросил, как дела с сайтом? "пишу" - ответил я ему. Он попросил показать ему то, что уже написано. Сказав ему, что внешне еще ничего не написано - похвалил себя, какой же я молодец, что не ринулся первым делом клепать рожу сайта, а начал писать классы, которые в дальнейшем помогут быстрому и удобному написанию кода сайта.
К чему все это я написал?
Да к тому что любой более менее профессиональный программист, а так же человек занимающийся разработкой должен документировать свой код. Если не должен, то мог бы, ибо 1 из показателей уважения своих коллег является именно документация.
В моем коде каждая функция, каждый метод, каждый шаг задокументированы :Ъ
Ибо я знаю, что заказчику может потребоваться дополнить возможности сайта, и если они обратятся к кому либо из других программеров, им будет сделать это гораздо проще, нежели сидеть и пытаться понять, зачем эта функция, а зачем та, и как в этой каше вообще что то работает.
Код должен быть структурирован.
Это заключается не только в описании методов, переменных, классов, но и текстового оформления блоков кода. Гораздо понятнее когда написан так:
for($i=0;$i<100;$i++)чем так:
{
echo "entering $i step";
# some code
if(condition)
FuncOne();
else
FuncTwo();
}
for($i=0;$i<100;$i++) {
echo "entering $i step";
# some code
if(condition) FuncOne();
elseFuncTwo();
}
Являясь программистом нужно понимать, что уважение других порождает уважение к тебе, и когда программист будет дополнять ваш документированный код вероятность что он будет благодарен вам в облегчении этого процесса модификации, чем ругаться матом очень велика. Испытал на собственном опыте
Комментариев нет:
Отправить комментарий