Visual Studio 확장을 게시하는 모범 사례 검사 목록

아티클
01/13/2024

Visual Studio 확장을 게시하기 전에 기억해야 할 사항 목록은 다음과 같습니다.

다음 비디오에서는 확장이 최상의 상태인지 확인하는 모범 사례를 소개합니다.

스레딩 규칙 준수

VSIX 프로젝트에 Microsoft.VisualStudio.SDK.Analyzers NuGet 패키지를 추가하면 스레딩에 대한 일반적인 모범 사례 위반을 발견하고 수정하는 데 도움이 됩니다.

고품질 아이콘 추가

모든 확장에는 연결된 아이콘이 있어야 합니다. 아이콘이 크기가 96DPI 이상인 90x90 픽셀의 고품질 .png 파일인지 확인합니다. VSIX 프로젝트에 아이콘을 추가한 후 .vsixmanifest 파일에 아이콘과 미리 보기 이미지로 등록합니다.

이름 및 설명

연구에 따르면 간단한 설명식 이름과 정확한 설명을 포함한 확장이 사용자에게 더 많이 설치될 가능성이 높다는 것을 알 수 있습니다. 이름이 확장 기능이 수행하는 작업의 본질을 반영하는지 확인합니다. .vsixmanifest 파일의 간단한 설명은 확장이 수행하는 작업에 대한 기대치를 설정해야 합니다. 따라서 어떤 문제가 해결되고 어떤 주요 기능이 있는지 간략하게 언급하는 것이 중요합니다.

우수한 Marketplace 설명 작성

이는 확장을 성공적으로 만들기 위해 수행해야 하는 가장 중요한 사항 중 하나입니다. 좋은 설명은 다음과 같이 구성됩니다.

확장에서 추가한 UI의 스크린샷/애니메이션 GIF
개별 기능에 대한 자세한 설명입니다.
해당하는 경우 자세한 내용으로 연결되는 링크입니다.

라이선스 추가

이 라이선스는 Marketplace, VSIX 설치 관리자, 확장 및 업데이트... 대화 상자에 표시됩니다. 사용자의 기대치를 설정하려면 항상 라이선스를 지정해야 합니다. choosealicense.com을 통해 사용자에게 적합한 라이선스를 찾을 수 있습니다. 라이선스는 질문과 모호성을 제거하는 데 도움이 되며, 이는 많은 Visual Studio 사용자에게 매우 중요합니다.

개인 정보 알림 추가

확장이 원격 분석과 같은 데이터를 수집하거나 다른 방법으로 원격 엔드포인트와 통신하는 경우 이에 대한 메모를 설명에 추가합니다.

가능하면 KnownMonikers 사용

Visual Studio에는 KnownMonikers 컬렉션에서 사용할 수 있는 수천 개의 아이콘이 함께 제공됩니다. 명령 단추에 아이콘을 추가할 때 Visual Studio 사용자에게 친숙한 디자인 언어의 일부이므로 기존 KnownMonikers 아이콘을 사용할 수 있는지 확인합니다. 다음은 KnownMonikers의 전체 목록이며 KnownMonikers 탐색기 확장을 사용하여 시나리오에 적합한 확장을 찾을 수 있습니다.

VS가 고유한 느낌이 나도록 만들기

Visual Studio 자체에서 사용하는 것과 동일한 디자인 패턴 및 원칙을 따르면 확장이 사용자에게 자연스럽게 느껴지도록 할 수 있습니다. 또한 제대로 디자인되지 못한 UI로 인한 방해 요소도 줄이게 됩니다. 모든 단추, 메뉴, 도구 모음, 도구 창이 사용자가 사용하기에 적합한 컨텍스트에 있는 경우에만 기본적으로 표시되는지 확인합니다. 따라야 할 몇 가지 규칙이 있습니다.

새 최상위 메뉴(파일, 편집 옆 ...)를 추가하지 마세요.
단추, 메뉴, 도구 모음이 적용되지 않는 컨텍스트에는 표시되지 않아야 합니다.
자동 로드가 필요한 경우(그렇지 않을 수 있음) 가능한 한 늦게 수행합니다.
자동 로드를 사용하지 않고 명령의 표시 유형을 전환하려면 VisibilityConstraints를 사용하세요.

적절한 버전 범위 사용

모든 사용자가 새 확장을 사용할 수 있도록 Visual Studio 2010까지 Visual Studio 버전을 지원하려고 할 수 있습니다. 문제는 이렇게 하면 확장이 지원하는 최소 버전보다 나중에 도입된 API를 더 이상 사용할 수 없다는 것입니다. 종종 이러한 새 API는 중요한 역할을 하고, Visual Studio 자체뿐만 아니라 확장의 성능과 안정성을 개선하는 데도 도움이 되는 경우가 많습니다.

지원할 Visual Studio 버전을 결정하기 위한 권장 사항은 다음과 같습니다.

Visual Studio의 이전 버전과 현재 버전만 지원하기 때문에 가능하면 오래된 버전은 지원하지 않습니다.
확장 가능한 버전 범위를 지정하지 마세요(예: [16.0,)). 버전 범위에 대해 자세히 알아봅니다.

다음을 통해 공유