StyleCop - Coding Guide / 스타일콥 코드 분석기 for C#

StyleCop은 Visual Studio 에서 코딩시에 코딩 가이드 라인을 잡아주는 코드 분석기 입니다.

DOWNLOAD는 아래의 경로에서

http://stylecop.codeplex.com/

다운로드 받으시고 그냥 설치하시면 됩니다. 물론 Visual Studio도 설치되어 있어야겠죠?

사용법을 살펴보겠습니다.

우선 코딩을 한 후 코드 작성창이나 솔루션 탐색기의 프로젝트에서 우측 클릭을 하게되면 Run styleCop 이라는 없던 버튼이 생깁니다.

요놈을 눌러줍니다.

눌러주면 화면 하단의 오류 목록창에 쫘악 뜨게 됩니다. 출력 창에서도 가이드를 위반한 갯수가 뜨게 됩니다.

막상 보게 되면 이 룰 위반사항들이 고개가 끄덕여질만큼 타당한것도 있는가하면 이건 너무 한거 아닌가 싶은것들도 있습니다.

상황에 따라 모두 해당 항목들을 준수하기는 힘들것입니다.

이러한 룰 들을 관리하려면 솔루션 탐색기에서 프로젝트에서 우측클릭하여 StyleCop settings를 찾아 클릭합니다.

눌러주시면 아래와 같은 설정창이 뜨는데요. Enabled Rules에서 필요없는 룰들은 체크 해제하시고 사용하시면 되겠습니다.

위반 사항을 몇가지만 보겠습니다.

경고 9 SA1101 : CSharp.Readability : The call to components must begin with the 'this.' prefix to indicate that the item is a member of the class. C:\Users\Downloads\MVCTest_Source\MVCTest\MVCTest\Form1.Designer.cs 16 32 MVCTest

경고 9에서는 component를 호출할 때 this. 키워드를 쓰지 않았다고 하는군요. this.component로 고쳐주었습니다.

경고 5 SA1201 : CSharp.Ordering : All methods must be placed after all fields. C:\Users\Downloads\MVCTest_Source\MVCTest\MVCTest\Form1.Designer.cs 87 1 MVCTest

모든 메서드는 모든 필드 뒤에 위치해야한다고 하네요. 이 경우에는 필드를 메서드들 보다 앞으로 옮겼습니다.

경고 12 SA1307 : CSharp.Naming : Public and internal fields must start with an upper-case letter: newval. C:\Users\Downloads\MVCTest_Source\MVCTest\MVCTest\IModel.cs 41 1 MVCTest

Public 혹은 internal 속성의 필드는 맨 앞글자가 대문자여야한다고 합니다.

newval -> Newval로 변경하였습니다.

이처럼 수정이 필요한 위반 항목들을 수정하고 다시 우측 클릭하여 Run StypeCop을 클릭하여 반복하시면 됩니다.

끝~