.NET 에서의 Code Analysis 툴인 FxCop.
잘들 사용하고 계신가요? ^^
솔직히, 저도 .NET 1.1 시절에는 그다지 잘 사용하지 않았습니다.
.NET 2.0이 되면서, VS.NET IDE에 통합이 되어 있어서 이젠 좀 관심을 갖게 되었는데요.
그래서, 신규 프로젝트는 모두 FxCop을 Enable 시켜놓고 진행하고 있습니다. (Debug 모드에서는 Disable 시켜 놓고, Release 모드에서 Enable 시켜 놓는 것이 좋습니다.)
그런데, FxCop 규칙을 적용하다 보면 부득이하게 해당 규칙에 위반할 수밖에 없는 상황이 나오는데요.
그런 경우, 해결할 수 있는 방법이 크게 2가지가 있습니다.
1. 프로젝트 규모로 해당 규칙을 Disable.
다음과 같이 "프로젝트 속성" 창에서, "Code Analysis" 부분을 통해서 특정 규칙에 대한 Enable/Disbale 설정이 가능합니다.
2. 코드 단위로 해당 규칙을 Disable.
규칙을 위반하는 .NET 코드에 대해서 SuppressMessage 특성을 설정해서 예외적으로 벗어납니다.
예를 들어서,
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1705:LongAcronymsShouldBePascalCased")]
public partial class DDDPanel : UserControl
{
개인적으로는, 위의 그림에서 보는 것처럼, "CA2210" 규칙을 제외하고는 가능한 FxCop 규정에 맞춰주고 부득이한 경우, 위와 같이 특성을 제공해서 컴파일을 하고 있습니다. 즉, 프로젝트 규모로 규칙을 disable 시키는 설정은 거의 하지 않는 다는 것이지요.
그나저나, 코드로 하는 것을 보니 상당히 귀찮습니다. 첫째로 너무 길죠. ^^;
게다가 중간에 "CA1705" 다음에 나오는 규칙의 타입명에 해당하는 "LongAcronymsShouldBePascalCased"까지 주어야 합니다. 더욱 문제는 바로 그 타입명 "LongAcronymsShouldBePascalCased"이 컴파일 경고 메시지에는 전혀 안 나온다는 것입니다.
일례로, 위의 구문에서 SuppressMessage를 제거하면.
Output 출력에는 다음과 같이 경고가 나오고,
D:\Program Files\Microsoft Visual Studio 8\Team Tools\Static Analysis Tools\FxCop\FxCopCmd.exe
/o:"..\..\Output\Release\Test.dll.CodeAnalysisLog.xml"
;
/r:D:\Program Files\Microsoft Visual Studio 8\Team Tools\Static Analysis Tools\FxCop\\rules /rid:-Microsoft.Design#CA2210
MSBUILD : warning : CA1705 : Microsoft.Naming : Correct the capitalization of type name 'DDDPanel'.
Eror List에는 다음과 같이 경고가 나옵니다.
Warning 1 CA1705 : Microsoft.Naming : Correct the capitalization of type name 'DDDPanel'. D:\workshop\Test\DDDPanel.cs 15
그래서, ^^; 제가 선택했던 방법은, "Error List"에서 해당 항목을 선택한 다음 "F1" 도움말을 호출하는 것이었습니다. 그러면, 온라인 도움말에서 타입명이 나오기 때문인데요.
오호...~~~ ^^;
오늘 새로운 것을 배웠습니다. Code Snippet과 비슷한 개념인데요. 자동으로 SuppressMessage 특성을 생성하도록 하는 방법이 MSDN Wiki 사이트에 댓글로 달려져 있었습니다.
방법은 매우 간단합니다. "Error List"에서 해당 항목을 오른쪽 마우스 버튼으로 눌러서 나오는 메뉴의 "SuppressMessage(s)"를 선택하는 것이었습니다. 다음 화면과 같이.
훌륭하군요. ^^ 위의 메뉴를 선택하면, 해당 코드의 바로 윗부분에 자동으로 SuppressMessage 특성이 추가됩니다.