вторник, 7 мая 2013 г.

По-моему - хорошая практика

По-моему хорошая практика - при исправлении ошибки, зафиксированной в базе ошибок, прямо в коде давать комментарий со ссылкой на исправляемую ошибку в базе данных по ошибкам (URL (в вики-подобной системе), номер ошибки (в баг-треккере типа Clear Quest или его аналогах), номер "тикета", etc.)

Лучше конечно сопровождать это и словесным комментарием. Но ведь - лень, да и зачастую - описание ошибки говорит само за себя.

Если написан тест к данному исправлению - неплохо ещё давать ссылку на тест.

Эта банальная практика позволяет в дальнейшем облегчать разборки из серии "а что это такое тут понаписано".

Можно конечно пользоваться комментариями и логами из CVS или SVN. Но комментарии в коде - по-моему и практичнее и удобнее.

Попробуйте. Может быть вам понравится.

2 комментария:

  1. ИМХО, лучше описание в VCS с кодом тикета писать. Так и код не "захламляется" всякими комментариями с кодами ошибок, и установить "что это такое тут понаписано" становится в 2 клика.

    ОтветитьУдалить