docs.microsoft.com'de birleşik bir .NET başvuru deneyimi duyuruyor

Bu gönderi, Azure Büyüme ve Ekosistem ekibinin Genel Müdürü Jeff Sandquisttarafından yazılmıştır.

Yaklaşık bir yıl önce docs.microsoft.com üzerinde .NET Core başvuru belgelerinin pilotunu yaptık. Bugün birleşik.NET API başvuru deneyimimizi duyurmaktan mutluluk duyuyoruz. Bir hobi geliştiricisinden bir startup'a, bir kuruluşa kadar geliştirici üretkenliğinin önemli olduğunu anlıyoruz. Bunu göz önünde bulundurarak, Microsoft'ta .NET API'lerini belgeleme, keşfetme ve gezinme şeklimizi standartlaştırmak için Xamarin ekibiyle yakın işbirliği yaptık.

Tüm .NET belgeleri - tek bir yerde

Daha önce, bir bulmak istiyorsanız. Microsoft tarafından gönderilen NET tabanlı SDK, sık kullandığınız arama motoruyla biraz zaman geçirerek hem indirebileceğiniz yeri bulmaya hem de ilgili API belgelerini keşfetmeye çalıştı.

İleride, tüm . NET uyumlu SDK'lar tek bir yerde birleştirilir ve aranabilir: https://docs.microsoft.com/dotnet/api. Burada .NET Framework, .NET Core, .NET Standard ve Xamarin için başvuru belgelerinin yanı sıra Azure NuGet paketlerimize yönelik belgeleri bulabilirsiniz. Gelecek aylarda bu deneyime daha fazla SDK ekleyeceğiz.

API Browser'a giriş

Ana hedefimiz, bir web tarayıcısından tüm .NET API'lerini aramak için IntelliSense benzeri bir deneyim getirmektir. Ad alanı, sınıf, yöntem veya arabirim için tam veya kısmi adını doğrudan API Tarayıcısı sayfasına yazabilirsiniz.

API Browser

Belirli bir türün, üyenin veya ad alanının hangi SDK'ya ait olduğundan emin değilseniz, API kapsamı açılan listesinden tüm API'ler seçebilir ve kullanılabilir tüm başvuru belgelerinde arama yapabilirsiniz. Alternatif olarak, aramanızı sınırlamak istiyorsanız, belirli bir çerçeveyi veya SDK'yı ve sürümünü (.NET Framework 4.7 gibi) seçebilir ve yalnızca bu API'ler kümesinde arama yapabilirsiniz.

API Browser deneyimi, içindekiler tablosunun en üstünde de tümleştirilir. NET tabanlı API'ler, başvuru belgelerinde nerede olursanız olun herhangi bir API'yi hızla bulmanıza olanak sağlar:

Belirli bir ad alanına girdikten sonra, API Browser'ın kapsamı yalnızca birbirine bağlı API ailesi olarak belirlenmiştir, bu nedenle aramanız her zaman bağlamınıza göre mümkün olan en iyi sonuçları döndürür.

Sürüm Oluşturma Desteği

Artık bir türün .NET Framework'ün belirli bir sürümünde mi yoksa Azure Depolama NuGet paketinde mi kullanılabilir üyeler olduğunu merak etmeniz gerekmez. Tek yapmanız gereken API Browser denetiminden sürümü değiştirmektir ve içerik buna göre ayarlanır:

Açık Kaynak düşünülerek oluşturulmuş

API Browser'ı oluşturmak için açık standartlar ve araçlar kullandık. Xamarin'in mdoc uygulamasıyla birlikte belge oluşturma araç zinciri olan DocFX kullandık.

Tüm yönetilen başvuru belgelerimiz artık NuGet gönderen veya .NET Framework veya .NET Coregibi ana çerçeve dağıtımlarının bir parçası olan ikili dosyalardan otomatik olarak oluşturulur.

Sürekli tümleştirme altyapımız, en son API'ler için artık yayından itibaren saatler içinde genel kullanıma sunabilecek, katkılara açık doğru belgelere sahip olmamızı sağlar. Ayrıca ECMAXML biçimindeki tüm .NET API belgelerinistandartlaştırdık. Bu, belgelenen SDK'ya bakılmaksızın tutarlı ve kapsamlı bir API gösterimi oluşturur. Ayrıca, otomatik oluşturulan belgelere eklenen Markdown'da içerik katkıda bulunabileceğiniz için dosya biçiminin karmaşıklıklarını bilmeniz gerekmez. Başvuru belgeleri için topluluk katkıları önümüzdeki ay etkinleştirilecektir.

İçeriğe odaklanma

Yeni deneyimlere ek olarak, başvuru içeriğini daha bulunabilir ve okunabilir olacak şekilde iyileştirdik. İçindekiler tablosunu her zaman ad alanı odaklı olacak şekilde güncelleştirdik. Bir ad alanı, tür veya üyedeki bilgilere göz atarken, size her zaman ilgili gruplandırılmış üyeleri & tüm alt türleriyle yalnızca üst ad alanını gösteririz:

Bu da başvuru sayfalarının dağınık olduğu ve genel genel bakışlar ve örnekler gibi en önemli bilgileri bir bakışta size gösterdiği anlamına gelir.

Ayrıca, başlangıçtan itibaren size uygun, seçtiğiniz programlama diline göre filtrelenmiş örnekler görürsünüz. Bunları bulmak için artık sayfanın en altına kaydırmanız gerekmez.

Geri bildirim temelli

Bu, başvuru belgeleri deneyimini yenilemenin yalnızca başlangıcıdır. Belgelerimizi nasıl daha cazip, kullanışlı hale getirebileceğimiz ve sizi mümkün olan en hızlı şekilde yola nasıl çıkaracağımıza ilişkin geri bildirimlerinizi duymak istiyoruz. UserVoice site gidin ve API Browser deneyimimizi nasıl geliştirebileceğimizi bize bildirin. Ayrıca, hızlı güncelleştirmeler için twitter, @docsmsftadresinden de bize ulaşabilirsiniz.