다음을 통해 공유


docs.microsoft.com 통합 .NET 참조 환경 발표

이 게시물은 Azure Growth and Ecosystem 팀의 총괄 매니저인 Jeff Sandquist의해 작성되었습니다.

거의 1년 전에 docs.microsoft.com .NET Core 참조 설명서를 파일럿했습니다. 오늘 통합 .NET API 참조 환경발표하게 되어 기쁩니다. 개발자 생산성은 취미 개발자부터 스타트업, 기업에 이르기까지 핵심이라는 것을 알고 있습니다. 이를 염두에 두고 Xamarin 팀과 긴밀히 협력하여 Microsoft에서 .NET API를 문서화, 검색 및 탐색하는 방법을 표준화했습니다.

모든 .NET 설명서 - 한 곳에서

이전에는 . Microsoft에서 제공하는 NET 기반 SDK는 즐겨 찾는 검색 엔진과 함께 시간을 보내고 다운로드할 수 있는 위치를 모두 찾고 관련 API 설명서를 검색해야 했습니다.

앞으로는 모든 것을 가질 계획입니다. NET 호환 SDK를 한 곳에서 통합하고 검색할 수 있습니다. https://docs.microsoft.com/dotnet/api. .NET Framework, .NET Core, .NET Standard 및 Xamarin에 대한 참조 설명서와 Azure NuGet 패키지에 대한 설명서를 찾을 수 있습니다. 앞으로 몇 달 안에 이 환경에 더 많은 SDK를 추가할 것입니다.

API 브라우저 소개

주요 목표는 IntelliSense와 유사한 환경을 제공하여 웹 브라우저에서 모든 .NET API를 검색하는 것입니다. API 브라우저 페이지직접 전체 또는 부분 이름을 입력하여 네임스페이스, 클래스, 메서드 또는 인터페이스를 검색할 수 있습니다.

API 브라우저

특정 형식, 멤버 또는 네임스페이스가 속한 SDK를 잘 모르는 경우 API 범위 드롭다운에서 모든 API 선택하고 사용 가능한 모든 참조 문서에서 검색하면 됩니다. 또는 검색을 제한하려는 경우 특정 프레임워크 또는 SDK 및 해당 버전(예: .NET Framework 4.7)을 선택하고 해당 API 집합 내에서만 검색할 수 있습니다.

API 브라우저 환경도 목차 맨 위에 통합되어 있습니다. NET 기반 API를 사용하면 참조 설명서 내의 위치에 관계없이 API를 빠르게 찾을 수 있습니다.

API 브라우저 페이지 내

특정 네임스페이스에 있으면 API 브라우저는 함께 연결된 API 제품군으로만 범위가 지정되므로 검색은 항상 컨텍스트에 따라 최상의 결과를 반환합니다.

버전 관리 지원

형식에 특정 버전의 .NET Framework 또는 Azure Storage NuGet 패키지에서 사용할 수 있는 멤버가 있는지 궁금할 필요가 없습니다. API 브라우저 컨트롤에서 버전을 변경하기만 하면 콘텐츠가 적절하게 조정됩니다.

버전 선택 메뉴를 보여 주는 스크린샷

오픈 소스를 염두에 두고 빌드

API 브라우저를 빌드하기 위해 개방형 표준 및 도구를 사용했습니다. Xamarin의 mdoc 애플리케이션과 함께 개방형 설명서 생성 도구 체인인 DocFX 핵심적으로 활용했습니다.

이제 모든 관리되는 참조 설명서는 NuGet 제공하거나 .NET Framework 또는 .NET Core 같은 기본 프레임워크 배포의 일부인 이진 파일에서 자동으로 생성됩니다.

지속적인 통합 인프라를 통해 릴리스 후 몇 시간 내에 공개될 수 있는 최신 API에 대한 정확한 설명서를 작성할 수 있습니다. 또한 문서화되는 SDK와 관계없이 일관되고 포괄적인 API 표현을 만드는 ECMAXML 형식모든 .NET API 설명서를 표준화했습니다. 또한 자동 생성된 문서에 포함된 Markdown의 콘텐츠를 작성할 수 있으므로 파일 형식의 복잡성을 알 필요가 없습니다. 참조 설명서에 대한 커뮤니티 기여는 다음 달 내에 사용하도록 설정됩니다.

콘텐츠에 집중

새로운 환경 외에도 참조 콘텐츠를 보다 검색 가능하고 읽을 수 있도록 최적화했습니다. 목차를 항상 네임스페이스 중심이 되도록 업데이트했습니다. 네임스페이스, 형식 또는 멤버에 대한 정보를 검색하는 경우 항상 모든 자식 형식이 있는 부모 네임스페이스만 해당 그룹화된 멤버에 & 표시됩니다.

참조 TOC

즉, 참조 페이지가 깔끔하고 일반적인 개요 및 예제와 같은 가장 중요한 정보를 한눈에 볼 수 있습니다.

또한 선택한 프로그래밍 언어로 필터링된 처음부터 사용자와 관련된 예제가 표시됩니다. 더 이상 페이지 맨 아래로 스크롤하여 찾을 필요가 없습니다.

피드백 기반

이는 참조 설명서 환경을 개선하기 위한 시작에 불과합니다. 설명서를 더 매력적이고 유용하게 만들고 가능한 한 빨리 진행하는 방법에 대한 피드백을 듣고 싶습니다. UserVoice 사이트 이동하여 API 브라우저 환경을 개선하는 방법을 알려주세요. 또한 빠른 업데이트를 위해 Twitter, @docsmsft언제든지 연락할 수 있습니다.