Metin biçimlendirme yönergeleri

Kalın, italik ve kod stillerinin metin öğelerinde tutarlı ve uygun biçimde kullanılması, okunabilirliği artırarak yanlış anlaşılmaların önlenmesine yardımcı olur. Metin biçimlendirme öğesi bu kılavuzun kapsamına alınmıyorsa Microsoft Yazma Stili Kılavuzu'na bakın. Aşağıdaki makaleler, metin biçimlendirme hakkında ayrıntılı yönergeler sağlar:

• Ortak metin öğelerini biçimlendirme

• Yönergelerdeki metni biçimlendirme

• Yaygın geliştirici öğelerini biçimlendirme

Kullanıcı arabirimi öğeleri

Menü öğeleri, iletişim kutusu adları ve metin kutularının adları gibi kullanıcı arabirimi öğeleri kalın metin içinde olmalıdır.

• Bu: Çözüm Gezgini'nde proje düğümüne sağ tıklayın veardından Yeni Öğe Ekle'yi> seçin.

• Bu değil: Çözüm Gezgini proje düğümüne sağ tıklayın ve ardından Yeni Öğe Ekle'yi > seçin.

Git repo ve dal adları

Git deposu veya dal adları yönergelerde seçildiğinde veya girildiğinde kalın metin kullanın.

• Bu: Dal menüsünden ana dalı seçin.

• Bu değil: Şube menüsünden "ana dal" öğesini seçin.

Yeni terim tanıtımları

Bir tanım veya açıklamayla birlikte yeni bir terim tanıtmak için italik metin kullanın. Yeni terimi ilk kez kullandığınızda italik yapın ve ardından tanım veya açıklama için normal metin kullanın.

• Bu: App Service’de uygulama, App Service planında çalışır. App Service planı, bir web uygulamasının çalışacağı bilgi işlem kaynaklarını belirler.

• Bu değil: App Service'te bir uygulama bir "App Service planında" çalışır. App Service planı, bir web uygulamasının üzerinde çalıştırılacak işlem kaynakları kümesini tanımlar.

Kod stili

Kod stilini şunun için kullanın:

• Yöntem adları, özellik adları ve dil anahtar sözcükleri gibi kod öğeleri.
• SQL komutları
• NuGet paket adları
• Komut satırı komutları*
• Veritabanı tablo ve sütun adları
• Yerelleştirilmesi gereken kaynak adları (sanal makine adları gibi)
• Tıklanabilir olmasını istemediğiniz URL'ler

Neden? Bazı stil kılavuzları, bu metin öğelerinin çoğunu kalın yazı ile belirtir. Ancak çoğu makale yerelleştirilir ve kod stilleri çevirmenlerin, metnin söz konusu bölümünün çevrilmeden bırakılacağını anlamasını sağlar.

Kod stili, birden çok satıra yayılan satır içi (') veya çevrelenmiş kod blokları ('' ile çevrelenmiş) olabilir. Uzun kod parçacıklarını ve yolları için etrafı çevrili kod bloklarını kullanın.

* Komut satırı komutlarında, tüm platformlarda destekleniyorsa dosya yollarında eğik çizgi kullanın. Yalnızca ters eğik çizgiler desteklendiğinde Windows'da çalışan komutları göstermek için ters eğik çizgi kullanın. Örneğin eğik çizgi tüm platformlarda .NET CLI üzerinde çalışır, bu nedenle yerine dotnet build foldername/filename.csprojkullanabilirsinizdotnet build foldername\filename.csproj.

Satır içi stilleri kullanan örnekler

• Bu: Varsayılan olarak Entity Framework, Id veya ClassnameID olarak adlandırılan özellikleri birincil anahtar olarak algılar.
• Bu değil: Varsayılan olarak Entity Framework, Id veya ClassnameID olarak adlandırılan özellikleri birincil anahtar olarak algılar.
• Bu: Microsoft.EntityFrameworkCore paketi, EF Core için çalışma zamanı desteği sağlar.
• Bu: Microsoft.EntityFrameworkCore paketi, EF Core için çalışma zamanı desteği sağlar.

Etrafı çevrili kod bloğu örnekleri

• Bu: Hiçbir komut, sadece bir IQueryable değişikliği yapan ifadeler tarafından veritabanına gönderilmez. Aşağıdaki kod gibi:

      ```csharp
      var students = context.Students.Where(s => s.LastName == "Davolio")
      ```
  

• Bu değil: Var students = context gibi yalnızca IQueryable'ı değiştiren deyimler tarafından veritabanına hiçbir komut gönderilmez. Students.Where(s => s.LastName == "Davolio").

• Bu: Örneğin, Get-ServiceLog.ps1 dizininde C:\Scripts betiğini çalıştırma için şunu yazın:

      ```powershell
      C:\Scripts\Get-ServiceLog.ps1
      ```
  

• Bu değil: Örneğin, C:\Scripts dizininde Get-ServiceLog.ps1 betiğini çalıştırmak için şunu yazın: "C:\Scripts\Get-ServiceLog.ps1."

• Tüm çevrelenmiş kod blokları onaylanmış bir dil etiketine sahip olmalıdır. Desteklenen dil etiketlerinin listesi için bkz. Belgelere kod ekleme.

Yer tutucular

Paragraf metni veya yordam adımlarında, kullanıcıların kendi bilgileriyle değiştireceği yer tutucu metin için italik kullanın.

• Bu: Parolayı girin

• Bu değil: "parola" girin

• Bu: -pparolasını girin

• Bu değil: -p parolasını girin

Kullanıcının giriş dizesinin bir bölümünü kendi değerleriyle değiştirmesini istiyorsanız, köşeli ayraçlarla işaretlenmiş yer tutucu metni kullanın (karakterden < küçük ve daha > büyük).

1. Seçenek: Yer tutucu sözcüğü veya kapsayan tümceciği çevrelemek için kod stili kullanın. Örneğin, tek bir tümcecik için satır içi kod biçimlendirmesi için tek arka uçlar ' veya kod çitli biçimlendirme için üç kez onay işareti ''' kullanabilirsiniz.

`az group delete -n <ResourceGroupName>`

şu şekilde işlenir:

az group delete -n <ResourceGroupName>

veya

2. Seçenek: Markdown'da ve \gibi \< köşeli ayraç karakterlerinden kurtulmak için ters eğik çizgi karakteri \> kullanın. Sol köşeli ayraçta \< yalnızca ilk kaçış gerekli olsa da, kapanış köşeli ayracından \> kaçış tutarlılık için de çalışır. İşlenen HTML, kaçış karakterini okuyucuya göstermez:

az group delete -n \<ResourceGroupName\>

şu şekilde işlenir:

az group delete -n <ResourceGroupName>

Yer tutucu hakkında okuyucuyu bilgilendirin: Yer tutucu örneklerinden önceki metinde, okuyucuya köşeli ayraç içindeki metnin kaldırılması ve gerçek değerlerle değiştirilmesi gerektiğini açıklayın. Kullanıcı girişi için italik kullanılması önerilir. Köşeli ayraçlı satır içi kod içinde italikleri biçimlendirebilirsiniz:

Aşağıdaki örnekte yer tutucu metni <ResourceGroupName> kendi kaynak grubu adınızla değiştirin.

Dikkat

Microsoft Learn sitesi, köşeli ayraçların doğru şekilde kaçılmaması veya metnin kod biçimlendirilmemesi durumlarında köşeli ayraç kullanan yer tutucu< metinleri işlemez>. Microsoft Learn derleme işlemi, yer tutucu< tümceciği okuyucunun tarayıcısı için tehlikeli olabilecek bir HTML etiketi olarak yorumlar >ve izin verilmeyen html-etiketi olarak bayraklar. Derleme raporunda bir öneri görürsünüz ve bu durumda yer tutucu sözcük Microsoft Learn sayfa çıkışında işlenmez.

Yer tutucularda içerik kaybını önlemek için, daha önce açıklandığı gibi biçimlendirme veya kaçış karakterlerini (code\<) kullanın\>.

{ } küme ayraçlarını el değmemiş yer tutucular olarak kullanmayı önerilmez. Okuyucular küme ayracı yer tutucularını aşağıdakilerde kullanılan gösterimin aynısı ile karıştırabilir:

• Değiştirilebilir metin
• Dizeleri biçimlendirme
• Dize ilişkilendirme
• Metin şablonları
• Benzer programlama yapıları

Büyük/küçük harf ve aralık: Yer tutucu adlarını kısa çizgilerle ("kebab büyük/küçük harf") veya alt çizgiyle ayırabilir veya Pascal büyük/küçük harf kullanarak yapabilirsiniz. Kebap olayı söz dizimi hataları oluşturabilir ve alt çizgiler altı çizili ile çakışabilir. Tamamen büyük harf kullanımı, birçok dilde tanımlı sabitlerle çakışabilir, ancak yer tutucu adlarına dikkat çekebilir.

<Resource-Group-Name> veya <ResourceGroupName>

Başlık

Başlıklara italik, kalın veya satır içi kod stili gibi satır içi stil uygulamayın.

Neden? Başlıkların kendi stilleri vardır ve diğer stillerin karıştırılması tutarsızlıklar oluşturur.

• Bu: Microsoft.NET.Sdk.Functions paketini içeri aktarma

• Bu değil: Microsoft.NET.Sdk.Functions paketini içeri aktarma

Bağlantı metni

Metni bağlamak için italik veya kalın gibi satır içi stil uygulamayın.

Neden? Kullanıcılar, tıklanabilir bağlantılar gibi metin öğelerini standart köprü metni olarak gördüğünde ayırt edebilir. Örneğin, bağlantıyı italik olarak şekillendirmek, metnin bir bağlantı olduğu gerçeğini gizleyebilir.

• Bu: NuGet paketi Microsoft.NET.Sdk.Functions , function.json dosyasını oluşturur.

Bu değil: NuGet paketi Microsoft.NET.Sdk.Functions , function.json dosyasını oluşturur.

Tuşlar ve klavye kısayolları

Tuşlara veya tuş birleşimlerine başvururken şu kurallara uyun:

• Tuş adlarının ilk harfini büyük yazın.
• Anahtar adlarını ve <kbd> HTML etiketleriyle </kbd> çevrele.
• Kullanıcının aynı anda seçtiği anahtarları birleştirmek için "+" kullanın.

Tuş ve klavye kısayolları örnekleri

• Bu: AltCtrl S'yi++ seçin.
• Bu değil: ALT+CTRL+S tuşlarına basın.
• Bu değil: tuşuna bas.ALT+CTRL+S

Özel durumlar

Tutarlı stil yönergeleri güvenilir bir müşteri deneyimi oluşturur ve yazma sürecini basitleştirir. Bu yönergelere ilişkin özel durumlar dikkatle değerlendirilmelidir.

Özel durum normalde kod çağıran alternatif bir metin stili kullanmayı içeriyorsa, makalenin yerelleştirilmiş sürümlerinde metni çevirmenin uygun olduğundan emin olun. Kod stilini kullanmadan yerelleştirmeyi engellemek istediğiniz senaryolar için bkz. Yerelleştirilmeyen dizeler.