기술문서

 > 

C#, .NET, Visual Studio

Visual Studio CodeLens 주요 기능

CodeLens는 Visual Studio의 강력한 생산성 기능 중 하나로, 코드 에디터 내에서 **코드를 보면서 관련 정보들을 바로 확인할 수 있도록 도와주는 시각적 지표(indicator)**입니다. 마치 코드 위에 렌즈를 덧댄 것처럼, 코드 라인 바로 위에 다양한 유용한 정보가 표시되기 때문에 "CodeLens"라는 이름이 붙었습니다.

CodeLens가 제공하는 주요 정보

CodeLens는 코드 위에 다음과 같은 유형의 정보를 표시하여 개발자가 코드를 더 잘 이해하고 관리할 수 있도록 돕습니다:

1. 참조(References): 해당 코드 요소(메서드, 클래스, 속성 등)가 프로젝트 내에서 몇 번이나 참조되고 있는지를 숫자로 보여줍니다. 이 숫자를 클릭하면 해당 참조 목록을 바로 확인할 수 있어, 코드가 어디에서 어떻게 사용되는지 쉽게 파악할 수 있습니다.

2. 변경 내역(Changes/Authors): 해당 코드 라인을 마지막으로 수정한 사람이 누구인지, 언제 수정했는지, 그리고 어떤 커밋(commit)을 통해 변경되었는지 보여줍니다. 팀 프로젝트에서 특정 코드의 히스토리를 빠르게 파악하는 데 매우 유용합니다. Git, Azure DevOps(TFS) 등 버전 관리 시스템과 연동됩니다.

3. 관련 작업 항목(Work Items): 해당 코드 요소와 연결된 Azure DevOps(TFS)의 작업 항목(Work Item)이 무엇인지를 보여줍니다. 버그, 기능 요청 등이 해당 코드와 어떻게 연결되어 있는지 한눈에 알 수 있습니다.

4. 테스트 상태(Tests): 해당 메서드에 대한 단위 테스트(Unit Test)가 존재하는지, 몇 개인지, 그리고 최근 테스트 실행에서 통과했는지 실패했는지를 표시합니다. 테스트 주도 개발(TDD)을 하거나 코드의 안정성을 빠르게 확인하는 데 도움이 됩니다.

5. 이슈(Issues): (확장 기능을 통해) 해당 코드와 관련된 GitHub 이슈 등을 표시하기도 합니다.

> 예시 화면 : 9 references : 9개의 참조의 내용을 레이어드 팝업으로 볼수 있습니다.

CodeLens의 장점

• 컨텍스트 스위칭 최소화: 코드를 보다가 다른 정보(참조, 히스토리 등)를 확인하기 위해 별도의 도구 창이나 브라우저로 전환할 필요 없이, 에디터 내에서 모든 정보를 얻을 수 있습니다. 이는 개발 흐름을 방해하지 않아 생산성을 크게 높여줍니다.

• 코드 이해도 향상: 코드 라인 하나하나에 대한 배경 정보(누가 바꿨고, 어디서 쓰이는지 등)를 즉각적으로 제공하여, 처음 보는 코드나 오래된 코드를 이해하는 데 걸리는 시간을 줄여줍니다.

• 협업 촉진: 팀원들이 어떤 코드를 작업했고, 어떤 작업 항목과 관련이 있는지 쉽게 공유하고 파악할 수 있습니다.

• 품질 관리: 테스트 상태 정보를 통해 코드의 안정성을 빠르게 평가하고, 실패한 테스트가 있는 경우 바로 확인할 수 있습니다.

CodeLens 사용 가능 에디션

CodeLens는 Visual Studio의 Professional, Enterprise 에디션에 기본적으로 포함되어 제공되는 고급 기능입니다.

이전 대화에서 제가 "Community 에디션에서는 제한적이거나 제공되지 않습니다"라고 언급했던 부분이 바로 이 부분입니다. Community 에디션은 대부분의 개발 기능을 제공하지만, CodeLens와 같이 협업 및 코드 분석에 특화된 일부 고급 기능은 Professional 이상 에디션의 특징입니다.

요약하자면, CodeLens는 코드를 작성하고 이해하고 유지보수하는 과정에서 개발자에게 필요한 핵심 정보를 코드 에디터 안에서 바로 보여주는 "정보 오버레이" 기능입니다. 특히 복잡한 코드베이스를 다루거나 팀 단위로 협업할 때 그 진가를 발휘합니다.