Microsoft MVP성태의 닷넷 이야기
VS.NET IDE: 40. FxCop - IDE 에서 제공해 주는 SuppressMessage 코드 [링크 복사], [링크+제목 복사],
조회: 20161
글쓴 사람
정성태 (techsharer at outlook.com)
홈페이지
첨부 파일
 

.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 설정이 가능합니다.

Code Analysis

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 적용
훌륭하군요. ^^ 위의 메뉴를 선택하면, 해당 코드의 바로 윗부분에 자동으로 SuppressMessage 특성이 추가됩니다.






[최초 등록일: ]
[최종 수정일: 6/27/2021]

Creative Commons License
이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.
by SeongTae Jeong, mailto:techsharer at outlook.com

비밀번호

댓글 작성자
 




1  2  3  4  5  6  7  [8]  9  10  11  12  13  14  15  ...
NoWriterDateCnt.TitleFile(s)
13743정성태9/26/20246430닷넷: 2298. C# - Console 프로젝트에서의 await 대상으로 Main 스레드 활용하는 방법 [1]
13742정성태9/26/20246718닷넷: 2297. C# - ssh-keygen으로 생성한 ecdsa 유형의 Public Key 파일 해석 [1]파일 다운로드1
13741정성태9/25/20245899디버깅 기술: 202. windbg - ASP.NET MVC Web Application (.NET Framework) 응용 프로그램의 덤프 분석 시 요령
13740정성태9/24/20245756기타: 86. RSA 공개키 등의 modulus 값에 0x00 선행 바이트가 있는 이유(ASN.1 인코딩)
13739정성태9/24/20245911닷넷: 2297. C# - ssh-keygen으로 생성한 Public Key 파일 해석과 fingerprint 값(md5, sha256) 생성 [1]파일 다운로드1
13738정성태9/22/20245635C/C++: 174. C/C++ - 윈도우 운영체제에서의 file descriptor, FILE*파일 다운로드1
13737정성태9/21/20245990개발 환경 구성: 727. Visual C++ - 리눅스 프로젝트를 위한 빌드 서버의 msbuild 구성
13736정성태9/20/20245990오류 유형: 923. Visual Studio Code - Could not establish connection to "...": Port forwarding is disabled.
13735정성태9/20/20246069개발 환경 구성: 726. ARM 플랫폼용 Visual C++ 리눅스 프로젝트 빌드
13734정성태9/19/20245774개발 환경 구성: 725. ssh를 이용한 원격 docker 서비스 사용
13733정성태9/19/20246109VS.NET IDE: 194. Visual Studio - Cross Platform / "Authentication Type: Private Key"로 접속하는 방법
13732정성태9/17/20246147개발 환경 구성: 724. ARM + docker 환경에서 .NET 8 설치
13731정성태9/15/20246747개발 환경 구성: 723. C# / Visual C++ - Control Flow Guard (CFG) 활성화 [1]파일 다운로드2
13730정성태9/10/20246398오류 유형: 922. docker - RULE_APPEND failed (No such file or directory): rule in chain DOCKER
13729정성태9/9/20247152C/C++: 173. Windows / C++ - AllocConsole로 할당한 콘솔과 CRT 함수 연동 [1]파일 다운로드1
13728정성태9/7/20246960C/C++: 172. Windows - C 런타임에서 STARTUPINFO의 cbReserved2, lpReserved2 멤버를 사용하는 이유파일 다운로드1
13727정성태9/6/20247502개발 환경 구성: 722. ARM 플랫폼 빌드를 위한 미니 PC(?) - Khadas VIM4 [1]
13726정성태9/5/20247406C/C++: 171. C/C++ - 윈도우 운영체제에서의 file descriptor와 HANDLE파일 다운로드1
13725정성태9/4/20246157디버깅 기술: 201. WinDbg - sos threads 명령어 실행 시 "Failed to request ThreadStore"
13724정성태9/3/20248017닷넷: 2296. Win32/C# - 자식 프로세스로 HANDLE 상속파일 다운로드1
13723정성태9/2/20248279C/C++: 170. Windows - STARTUPINFO의 cbReserved2, lpReserved2 멤버 사용자 정의파일 다운로드2
13722정성태9/2/20246021C/C++: 169. C/C++ - CRT(C Runtime) 함수에 의존성이 없는 프로젝트 생성
13721정성태8/30/20246049C/C++: 168. Visual C++ CRT(C Runtime DLL: msvcr...dll)에 대한 의존성 제거 - 두 번째 이야기
13720정성태8/29/20246214VS.NET IDE: 193. C# - Visual Studio의 자식 프로세스 디버깅
13719정성태8/28/20246356Linux: 79. C++ - pthread_mutexattr_destroy가 없다면 메모리 누수가 발생할까요?
13718정성태8/27/20247440오류 유형: 921. Visual C++ - error C1083: Cannot open include file: 'float.h': No such file or directory [2]
1  2  3  4  5  6  7  [8]  9  10  11  12  13  14  15  ...