C#에서 오류 및 경고 구성

경고 및 오류 이해하기

이 영상에서 데릭은 컴파일러 또는 로즐린 분석기 경고를 오류로 보고하는 개념을 소개합니다. 그는 이것이 향후 문제를 예방하는 데 도움이 될 수 있는 간단한 절차라고 설명합니다. 예를 들어, 비동기 메서드를 사용할 때 await 키워드를 사용하지 않으면 잠재적인 버그가 발생할 수 있습니다. 데릭은 그의 메서드 SaveChangesAsync가 기다려지지 않아서 경고를 발생시키는 시나리오를 설명합니다. 그는 그러한 경고를 조기에 해결하여 향후 더 큰 문제로 발전하지 않도록 하는 것이 중요하다고 강조합니다.

이러한 접근 방식은 코드 품질, 유지 관리 용이성 및 전반적인 시스템 안정성을 향상시키는 데 도움이 됩니다. 구성 파일, 예외 처리 또는 시스템 설정 등 어떤 부분을 다루든 이러한 경고를 효과적으로 관리하는 방법을 이해하는 것은 복원력이 뛰어난 애플리케이션을 구축하는 데 핵심입니다.

경고를 오류로 변환

경고를 오류로 바꾸려면 프로젝트 파일(.csproj)을 수정하는 것이 좋다고 데릭은 제안합니다. 그는 프로젝트 파일의 <PropertyGroup> 내에 <WarningsAsErrors> 요소를 추가하는 방법을 보여줍니다. 특히, await이 누락되었을 때 생성되는 경고 CS4014의 경우, 이 요소를 추가하면 경고를 오류로 변환하여 문제가 지속되면 빌드가 실패하게 만듭니다. 이러한 접근 방식은 더욱 엄격한 코딩 표준을 적용하고 애플리케이션 개발 과정에서 잠재적인 오류를 조기에 발견하는 데 도움이 됩니다.

<PropertyGroup>
  <WarningsAsErrors>CS4014</WarningsAsErrors>
</PropertyGroup>

<PropertyGroup>
  <WarningsAsErrors>CS4014</WarningsAsErrors>
</PropertyGroup>

로즐린 분석기에 개념 적용하기

데릭은 이러한 접근 방식을 Roslyn 분석기에도 확장하여 경고를 생성하도록 했습니다. 그는 마이크로소프트 Visual Studio 스레딩 분석기 패키지를 예시로 사용합니다.

데릭은 이 패키지를 프로젝트에 추가하고 비동기 문제를 다시 발생시킴으로써 Roslyn 분석기 경고가 오류로 바뀔 수도 있음을 보여줍니다. 이는 코딩 표준 및 관행을 준수하도록 이러한 분석 도구에 의존하는 팀에게 특히 유용합니다. 이러한 경고를 오류로 처리함으로써 개발자는 코드가 프레임워크에서 정의한 지침을 준수하고 프로덕션 환경에서 발생할 수 있는 잠재적인 문제를 방지할 수 있습니다.

<ItemGroup>
  <PackageReference Include="Microsoft.VisualStudio.Threading.Analyzers" Version="16.10.56" />
</ItemGroup>

<PropertyGroup>
  <WarningsAsErrors>VSTHRD103</WarningsAsErrors>
</PropertyGroup>

<ItemGroup>
  <PackageReference Include="Microsoft.VisualStudio.Threading.Analyzers" Version="16.10.56" />
</ItemGroup>

<PropertyGroup>
  <WarningsAsErrors>VSTHRD103</WarningsAsErrors>
</PropertyGroup>

특정 경고 무시

특정 경고가 프로젝트와 관련이 없을 수도 있는 시나리오가 있습니다. 데릭은 프로젝트 파일에서 <NoWarn> 요소를 사용하여 이러한 경고를 무시하는 방법을 논의합니다. 그는 비동기 명명 규칙 경고(VSTHRD200)를 예로 들며, 이에 동의하지 않고 <NoWarn>에 추가하여 무시하기로 선택합니다. 이 기능을 통해 개발자는 경고 및 오류 보고 시스템을 특정 요구 사항에 맞게 조정하여 프로젝트에 가장 중요한 문제에 집중하고 중요하지 않은 문제는 무시할 수 있습니다.

<PropertyGroup>
  <NoWarn>VSTHRD200</NoWarn>
</PropertyGroup>

<PropertyGroup>
  <NoWarn>VSTHRD200</NoWarn>
</PropertyGroup>

솔루션 전체 구성

추가 팁으로, 데릭은 이러한 구성을 솔루션 전반에 걸쳐 적용하는 방법을 Directory.Build.props 파일을 사용하여 보여줍니다. 이 방법은 솔루션 내 모든 프로젝트에서 설정의 일관성을 보장하여 시간을 절약하고 일관성을 유지합니다. 팀들은 이러한 설정들을 중앙 집중식 파일에 저장함으로써 여러 프로젝트에 걸쳐 동일한 코딩 표준 값과 규칙을 적용할 수 있으며, 모든 코드베이스가 동일한 지침을 준수하도록 보장할 수 있습니다. 이는 특히 여러 프로젝트를 진행 중인 대규모 팀이나 조직에 유용할 수 있습니다.

<Project>
  <PropertyGroup>
    <WarningsAsErrors>CS4014;VSTHRD103</WarningsAsErrors>
    <NoWarn>VSTHRD200</NoWarn>
  </PropertyGroup>
</Project>

<Project>
  <PropertyGroup>
    <WarningsAsErrors>CS4014;VSTHRD103</WarningsAsErrors>
    <NoWarn>VSTHRD200</NoWarn>
  </PropertyGroup>
</Project>

결론

데릭 코마틴이 제시한 다양한 구성 단계를 따르면 C# 프로젝트에서 컴파일러 및 Roslyn 분석기 경고를 효과적으로 관리할 수 있습니다. 경고를 오류로 구성하면 코드 품질을 높게 유지하고 잠재적인 문제가 발생하는 것을 방지할 수 있습니다. 더 자세한 안내를 원하시면 Derek의 CodeOpinion YouTube 채널 에 있는 "C#에서 오류 및 경고 구성하기"라는 제목의 전체 영상을 시청하세요.