StyleCop

Standardizasyon, her ne kadar göz ardı edilse de profesyonel yazılım projelerinin sağlıklı bir yaşam sürebilmesi için olmazsa olmazlardandır. Yazılan projenin bir çok yazılımcı tarafından ortak bir çalışma ile geliştirilebilmesi imkanı tüm yazılımcıların birbirinden tamamen farklı tarzlarda kodlama yapabilmesine ne yazık ki olanak tanımaktadır. Bir yazılımcı if bloğunu tek satırda yazarken başka bir yazılımcı ise if bloğu içerisinde, öncesinde ve sonrasında gereksiz bir dolu boşluk bırakabilme özgürlüğüne sahiptir. Dolayısıyla bu formatlama tamamen yazılımcının insiyatifindedir. Diğer bir yandan bu tarz bir standart dışı hareketin gerçekleşmesinin sadece aynı seviyedeki yazılımcılar için geçerli olduğunu düşünememek lazım. Senior yazılımcılar ile birlikte stajyerlerin de aynı projede yer alması günümüz uygulamalarında çok olası bir ihtimal.

Bu yazıda anlatacağım “StyleCop” aracı kod stilinde standardizasyonu ve belirli kurallara uyulmasını sağlamaktadır. StyleCop uygulaması Microsoft bünyesindeki bir yazılımcı tarafından geliştirilmiş olup popüleritesini her geçen gün arttırmıştır. Bu aracı diğer efsaneleşen MS aracı FxCop ile karıştırmamak gerekir. StyleCop kod formatına (yazım stili, boşluklar, isimlendirmeler vs.) bakarken, FxCop ise kodun analizini (optimizasyon, performans ipuçları vs.) yapar. Bir diğer büyük fark ise StyleCop’un kaynak kodlarını, FxCop’un ise IL kodlarını incelemesidir.

Kurulum

İlk yapmamız gereken StyleCop kurulum dosyasını http://stylecop.codeplex.com/ adresinden indirmek ve bilgisayarımıza kurmak olacak. Kurulumu ve kullanımı çok basit olan bu araç kurulum işleminin ardından VisualStudio ile entegre bir context menü ile karşımıza çıkmaktadır.

Buradan sonra tek yapmamız gereken ‘Run Style Cop’ düğmesine basmak ve sonuçları gözlemlemek olacaktır.

Yukarıda görüldüğü gibi StyleCop bize iki adet uyarı vermiştir. Bu uyarılara çift tıkladığımızda bize kodun neresinde hata olduğunu Visual Studio göstermektedir.

Kuralları Düzenlemek

Eski projelerinizi tarattığınızda ise muhtemelen yüzlerce uyarı ile karşılaşabilirsiniz. Bir çok hata ise gerçekten gerekmiyor olacak ve bu uyarıları almak istemeyebileceksiniz. Bu durumda ‘StyleCop Settings’ düğmesine tıklayıp istemediğiniz kuralları kapatabilirsiniz. Örnek vermek gerekirse dokümantasyon kuralları bir çok proje için gerekmeyecektir ve bu sekme tamamen kapatılabilir. Hangi kuralı kapatacağınızı daha rahat bulabilmeniz için uyarıların başındaki kodlardan faydalanabilirsiniz (“SA1505″).

Ayarları değiştirdiğinizde projenizde “Settings.StyleCop” isminde bir dosya oluşturuluyor olacak. Bu dosya StyleCop’un kendi default kurallarını ezen XML dosyasıdır. Dolayısıyla bu kısımdan yaptığınız değişiklikler aslında proje bazlı değişikliklerdir yani farklı projeleri etkilemezler.

Tüm projelerinizde ortak bir kural seti oluşturmak isterseniz default kuralları değiştirmeniz gerekir. Bu işlemi ise “Settings Files > Merge with settings file found in parent folders > Edit” düğmesine basarak yapabilirsiniz. Böylelikle buradan yapılan ayarlar her proje için default ayarlar olur ve ayrı ayrı her projede yeniden ayar yapmanıza gerek kalmaz. Projelerinizdeki “Settings.StyleCop” dosyalarına da haliyle ihtiyacınız kalmaz, arzu ettiğiniz taktirde bu dosyaları silebilirsiniz.

Farklı Ortamlar

Farklı makinalarda da aynı kuralları tekrar tekrar değiştirmek can sıkıcı olabilir. Bu gibi durumlarda StyleCop kurulum klasöründeki kural setini taşımanız yeterlidir. Kurulum yaptıktan sonra kendi makinanızdaki dosyayı diğer makinanın gene aynı lokasyonundaki dosyanın üzerine yazmanız tüm ayarların taşınması için yeterlidir.

Sürücü:\Program Files\Microsoft StyleCop 4.3.3.0\Settings.StyleCop