Минимальное качество кода

Перед тем, как кому-нибудь показывать последние изменения в проекте (т.е. делать check-in), полезно проверить, что код удовлетворяет минимальным требованиями к качеству.

  1. Необходимо проверить, что код вообще компилируется. Если check-in делается для части файлов, то необходимо убедиться, что новые изменения никак не связаны с файлами, которые остаются незалитыми. Кроме того, полезно проверить, что все необходимые dll залиты на ТФС.
  2. Необходимо исправить предупреждения, которые пишет Resharper, кроме некоторых замечаний, которые можно отключить. Например, требование соответствия структуры папок структуре namespace. Возражения вроде того, что Resharper «тупит» очень часто на поверку оказываются верными с точностью до наоборот.
  3. Новый код должен быть документирован при помощи xml-комментариев. Тэги summary, param и returns обязательны для заполнения. Примеры, как заполняются эти теги, можно смотреть в русской версии msdn. Старый код можно оставлять без комментариев до того момента, как там придется что-то менять.
  4. Необходимо провести проверку нового кода с помощью Code Analysis.

Code Analysis выполняется следующим образом. Сначала в свойствах нужного проекта выбирается набор применяемых правил. Для простоты можно выбрать стандартный набор правил Microsoft Minimum Recommended Rules.

После этого сам анализ можно запускать по щелчку правой кнопки на проекте.

Все найденные замечания отобразятся в стандартной панели.

Если какое-то замечание было определено неправильно (а такое бывает не так уж и часто), то его можно убрать, нажав пункт Supress warning в контекстном меню.

Post a comment or leave a trackback: Trackback URL.

Оставьте комментарий