StyleCop – pastuch na niechluja!

Jest pewien sprytny sposób na niechluja w kodzie. Można zmusić kodera do trzymania się określonej etykiety kodowania przy pomocy narzędzia o nazwie StyleCop.

W celu instalacji należy uwarzyć magiczną miksturę w kotle o nazwie Package Manager ConsoleInstall-Package StyleCop.Analyzers.

Po instalacji w okienku Solution Explorer znajdziemy w referencjach zainstalowanego StyleCopa, zawiera on w sobie listę dyrektyw jakie będzie można skonfigurować wedle własnego uznania.

StyleCop

VS podczas kompilacji wyrzuci listę ostrzeżeń dotyczących niezgodności w stylu kodowania. Obrazuje to poniższy zrzut ekranu.

StyleCop

W powyższym przypadku StyleCop sugeruje, iż usingi powinny być objęte w obszar przestrzeni nazw. Wskazuje na to odpowiednia dyrektywa SA1200.

I teraz gdzie ten pastuch, a proste obecnie niespójności w stylu kodowania skutkują jedynie ostrzeżeniami. Można skonfigurować StyleCop tak by wywalał błędy:D. Tym samym zmuszał do poprawy.

 

 

Zbrodni tej dokonać można  poprzez wskazanie dyrektywy w referencjach analizatora StyleCop.Analyzers. Wciśnięcie prawego przycisku myszki, wyborze Set Rule Set Severity i zaznaczeniu Error. Efekt działania na zrzucie poniżej.

 

 

Każdy fragment kodu nie spełniający dyrektywy SA1200, będzie powodował błąd, czyli będzie do poprawy, nawet najdrobniejszy szczegół jak za dużo spacji za średnikiem, czy za dużo pustych linii między metodami, jest tego wiele zachęcam do przetestowania!

 

Być może jest to chamskie:D, jednak uważam, iż jest to dobry sposób by wymusić na programiście dyscyplinę dbania o styl kodu.

 

Jest to post przygotowany na potrzeby konkursu „Daj Się Poznać 2017” organizowanym przez Macieja Aniserowicza.