Эта заметка освящает вопрос работы программиста в составе небольшой команды коллег (таких же программистов) внутри IT-компании среднего звена при работе над относительно большим проектом, для новичков.
1. Используйте системы контроля версий.
К примеру я использую Git. Не буду пояснять чем она лучше или хуже того же SVN, не буду вдаваться в технические подробности. Просто распишу смысл.
Итак, когда вы в параллельном режиме работаете группой над одним и тем же программным кодом, то система контроля версий поможет каждому из членов команды быстро и без головной боли отследить все изменения, кто, где и что накодил (особенно это заметно, когда в исходниках несколько тысяч строк).
P.S. Git потребует некоторого времени на первоначальное освоение, но оно того стоит. За полдня-день-два у вас вполне получится с этой штукой разобраться, чтобы использовать её с пользой для себя и команды.
2. Документируйте свой код.
…чтобы коллеги не вспоминали вас нехорошими словами, когда кто-то из них по каким-либо причинам будет разбираться с результатами / вносить поправки в результаты вашей работы. Да и сами вы можете забыть что за что отвечает на таком-то участке листинга спустя некоторое время. Потому всегда документируйте.
3. Старайтесь придерживаться определенных стандартов составления кода
Например, комментируйте описание к функциям по подобию вот этого:
<?php
/**
* Проверяем есть ли у пользователя с $uid прерванные прохождения тестирования
* или нет. Если есть, то возвращаем result_id, номер блока и question_id в
* виде массива.
*
* @param type $uid
* @return array
*/
function exampleMod_check_interrupted_test($uid) {
...
}
P.S.
4. Используйте IDE!
Не надо всяких Vim, Geany, Notepad++ и прочих. С IDE, например, NetBeans или PhpStorm легче придерживаться уже упомянутых выше стандартов написания кода. Кроме того, в них содержаться различные приятные мелочи, например в NetBeans есть встроенная поддержка Git (1 клик мышкой и коммит отправлен), SVN, Mercurial; автоформатирование кода и др.
5. Не надо писать идеальный код, но и говнокода тоже не надо
Не старайтесь писать идеальный на ваш взгляд программный код (т.к. всегда есть временные рамки на разработку того или иного функционала, сроки), пишите рабочий код, но в то же время не увлекайтесь говнокодом (дабы потом не пришлось его «разгребать»).
6. Разбивайте объемный код на несколько файлов
Не следует стараться запихать несколько тысяч строк в один файл, т.к. это мат, мат и ещё раз мат. Особенно при разборе подобных творений (тратится лишнее время). Разбивайте всё на небольшие файлики с комментариям, см. пункты 2 и 3.
* * *
Описанные советы помогут вам скоординировать свою работу и работу коллег наиболее эффективным образом, сосредотачиваясь на решении конкретных задач, не увязая в мелочах.
Свежие комментарии