CodeBlock

Ne zaman kullanılır

• Geliştirici belgelerinde, API anahtarı kurulum adımlarında ve entegrasyon örneklerinde birden fazla satır kod göstermek için.
• Kullanıcının bir komutu ya da yapılandırmayı kopyalaması gerektiğinde.

Ne zaman kullanılmaz

• Tek bir değeri kopyalatmak için: Copy kullanın.
• Metin içindeki kısa kod parçaları için: satır içi code kullanın.
• Bir tuşu göstermek için: Kbd kullanın.

Anatomi

1. Başlık: İsteğe bağlı figcaption; başlık, dil ve kopyala düğmesi.
2. Kaydırma bölgesi: Odaklanabilir, adlı bölge; uzun satırlar yana kayar.
3. Satır numarası: İsteğe bağlı; ekran okuyucu atlar, seçilmez ve kopyalanmaz.
4. Kod satırı: Eşaralıklı yazı; vurgulanabilir.

Davranış

• Kod yazıldığı gibi gösterilir; baştaki ve sondaki boş satırlar atılır.
• Kopyala düğmesi kodun tamamını, satır numaraları olmadan panoya yazar ve onay gösterir.
• Sözdizimi renklendirmesi yoktur; language yalnızca başlıkta yazılır.

Yönergeler

• Örnekleri çalışır halde ve kısa tutun.
• Gerçek anahtar ya da müşteri verisi yerine yer tutucu kullanın.
• Uzun komutlarda wrap kullanın; kodda yatay kaydırmayı tercih edin.

İçerik

• Başlık dosya adı ya da ne yaptığını söyleyen kısa bir ifade olur: “Kurulum”, config.json.
• Kod açıklamaları kodun içinde değil, CodeBlock’tan önceki metinde yer alır.

İlgili bileşenler

• Copy: Tek bir değeri kopyalar.
• Kbd: Tuş ve kısayol gösterir.