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.

Kalın

Menü seçimleri, iletişim kutusu adları ve girdi alanı adları gibi kullanıcı arabirimi öğeleri için kalın metin kullanın.

Örnekler

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

İtalik

İtalik metni şunun için kullanın:

• Tanımı veya açıklamasıyla birlikte yeni terimleri belirtirken.
• Dosya adları, klasör adları, yollar.
• Kullanıcı girişi.

Örnekler

• 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.
• Bu: HttpTriggerCSharp.cs içindeki kodu aşağıdaki kodla değiştirin.
• Bu değil: içindeki HttpTriggerCSharp.cs kodu aşağıdaki kodla değiştirin.
• Bu: Ad için ContosoUniversity girin ve Ekle'yi seçin.
• Bu değil: Ad için "ContosoUniversity" yazın ve Ekle'yi seçin.

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? Eski stil kılavuzları, bu metin öğelerinin birçoğunun kalın olması gerektiğini 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, C:\Scripts dizininde Get-ServiceLog.ps1 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

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>

Okuyucuyu yer tutucu hakkında bilgilendirin: Bu tür 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.

{ } 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. Tümü büyük harfler birçok dilde adlandırılmış sabitlerle çakışabilir, ancak yer tutucu adına da dikkat çekebilir.

<Resource-Group-Name> veya <ResourceGroupName>

Başlıklar ve bağlantı metinleri

Başlıklara veya köprü metnine 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, bir bağlantıyı italik olarak şekillendirmek, metnin bir bağlantı olduğu gerçeğini gizleyebilir. Başlıkların kendine özgü bir stili vardır ve diğer stillerle karıştırılması kötü görüntülere neden olur.

Başlık ve bağlantı metni örnekleri

• Bu: function.json dosyası, Microsoft.NET.Sdk.Functions NuGet paketi tarafından oluşturulur.

• Bu değil: function.json dosyası, Microsoft.NET.Sdk.Functions NuGet paketi tarafından oluşturulur.

• Bu:

  ### The Microsoft.NET.Sdk.Functions package
  

• Bu değil:

  ### The *Microsoft.NET.Sdk.Functions* package
  

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: Alt+Ctrl 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

Stil kılavuzları, katı kurallar değildir. Okunabilirliği olumsuz etkilemeleri durumunda farklı bir şey yapın. Örneğin, çoğunlukla kod öğelerinden oluşan bir HTML tablosunun her yerinde kod stilinin kullanılması fazla karmaşık bir görüntüye yol açabilir. Bu bağlamda kalın metin stilini seçebilirsiniz.

Normalde kullanılan kod stiline alternatif bir metin stili seçerseniz, metnin makalenin yerelleştirilmiş sürümlerinde çevrilmesinin uygun olduğundan emin olun. Kod stili, çeviri sürecini otomatik olarak engelleyen tek stildir. Kod stilini kullanmadan yerelleştirmeyi engellemek istediğiniz senaryolar için bkz. Yerelleştirilmeyen dizeler.