Belgelere kod ekleme

docs.microsoft.com’da yayımlanmış bir makaleye kod öğeleri ve kod parçacıkları eklemenin birkaç yolu vardır:

• Bir satırdaki bağımsız öğeler (sözcükler).

  code stilinin bir örneği aşağıda verilmiştir.

  Metninize yakın kod bloğundaki adlandırılmış parametrelere ve değişkenlere başvuru yaparken kod biçimini kullanın. Kod biçimi özellikler, yöntemler, sınıflar ve dil anahtar sözcükleri için de kullanılabilir. Daha fazla bilgi için bu makalenin devamındaki Kod öğeleri bölümüne bakın.

• Makale Markdown dosyasındaki kod blokları.

      ```csharp
      public static void Log(string message)
      {
          _logger.LogInformation(message);
      }
      ```
  

  Kodu bir kod dosyasına başvuru olarak göstermek pratik değilse satır içi kod bloklarını kullanın. Daha fazla bilgi için bu makalenin devamındaki Kod blokları bölümüne bakın.

• Yerel depodaki kod dosyasına başvuru ile kod blokları.

  :::code language="csharp" source="intro/samples/cu/Controllers/StudentsController.cs" range="2-24,26":::
  

  Daha fazla bilgi için bu makalenin devamındaki Depo içi kod parçacığı başvuruları bölümüne bakın.

• Başka bir depodaki kod dosyasına başvuru ile kod blokları.

  :::code language="csharp" source="~/samples-durable-functions/samples/csx/shared/Location.csx" highlight="2,5":::
  

  Daha fazla bilgi için bu makalenin devamındaki Depo dışı kod parçacığı başvuruları bölümüne bakın.

• Kullanıcının kodu tarayıcıda yürütmesine izin veren kod blokları.

  :::code source="PowerShell.ps1" interactive="cloudshell-powershell":::
  

  Daha fazla bilgi için bu makalenin devamındaki Etkileşimli kod parçacıkları bölümüne bakın.

Makale, bu kod ekleme yollarından her biri için Markdown’ı açıklamanın yanı sıra tüm kod blokları için genel kılavuz sağlar.

Kod öğeleri

“Kod öğesi” bir programlama dili anahtar kelimesi, sınıf adı, özellik adı vb.ni ifade eder. Neyin kod sayıldığı her zaman kesin olarak belli değildir. Örneğin NuGet paket adları kod olarak düşünülmelidir. Emin olamadığınız durumlarda Metin biçimlendirme yönergelerine bakın.

Satır içi kod stili

Makale metnine kod öğesi eklemek için başına ve sonuna ters tik işaretleri (`) koyarak kod stilini belirtin. Satır içi kod stili, üçlü ters tırnak biçimini kullanmamalıdır.

Bir makale yerelleştirildiğinde (diğer dillere çevrildiğinde) kod stilindeki metinler çevrilmeden bırakılır. Kod stilini kullanmadan yerelleştirmeyi engellemek istiyorsanız bkz. Yerelleştirilmeyen dizeler.

Kalın yazı stili

Bazı eski stil kılavuzları, satır içi kodlar için kalın stili kullanır. Kod stili okunurluğu güçleştirecekse kalın yazı stili de bir seçenektir. Örneğin, çoğunlukla kod öğelerinden oluşan bir Markdown tablosunun her yerinde kod stilinin kullanılması fazla karmaşık bir görüntüye yol açabilir. Kalın stilini kullanmayı tercih ederseniz kodun yerelleştirilmediğinden emin olmak için yerelleştirilmeyen dizeler söz dizimini kullanın.

Bağlantılar

Bazı bağlamlarda başvuru belgelerine bağlantı vermek koddan daha faydalı olabilir. Bağlantı kullanıyorsanız, bağlantı metnine kod biçimi uygulamayın. Bir bağlantıya kod stili uygulanması, metnin bağlantı olduğunun anlaşılamamasına sebep olabilir.

Bağlantı kullanır ve aynı öğeye aynı bağlamda daha sonra yeniden başvurursanız sonraki örnekler için bağlantı yerine kod biçimi kullanın.

Yer tutucular

Kullanıcının, görüntülenmiş bir kodun bir bölümünü kendi değerleriyle değiştirmesini istiyorsanız, açılı parantezlerle işaretlenen yer tutucu metni kullanın. Örnek:

az group delete -n <ResourceGroupName>

Köşeli ayracın gerçek değerleri değiştirirken kaldırılması gerektiğini unutmayın. Microsoft yazma stili Kılavuzu, açılı parantez içine alınmış satır içi kod içinde kullanabileceğiniz italik için çağırır:

<ResourceGroupName> kaynak grubunun where...

Küme ayraçları {}, sözdizimi yer tutucuları olarak kullanım için önerilmez. Bunlar, değiştirilebilir metin, biçim dizeleri, dize ilişkilendirme, metin şablonları ve benzer programlama yapıları içinde kullanılan aynı gösterimle karışıyor olabilir.

Yer tutucu adları kısa çizgilerden ("Kebab Case"), alt çizgi ile veya hiç ayrılamaz (Pascal Case) ile ayrılabilir. Kebab Case, sözdizimi hataları oluşturabilir ve alt çizgi, altı çizili ile çakışabilir. Hepsi, çok sayıda dilde adlandırılmış sabitler ile çakışabilir, ancak aynı zamanda yer tutucu adına dikkat çekebilir.

<Resource-Group-Name> veya <ResourceGroupName>

Kod blokları

Bir belgeye kod eklemek için kullanılan söz dizimi, kodun bulunduğu yere bağlıdır:

• Makale Markdown dosyasında
• Aynı depodaki bir kod dosyasında
• Farklı bir depodaki bir kod dosyasında

Aşağıdakiler, bu üç kod bloğu türü için geçerli yönergelerdir:

• Ekran görüntüleri
• Kod doğrulamayı otomatikleştirin
• Kodun önemli satırlarını Vurgula
• Yatay kaydırma çubuklarından kaçının
• Hatalı kodu açık bir şekilde tanımla

Ekran görüntüleri

Yukarıdaki bölümde listelenen tüm yöntemlerin sonucunda kullanılabilir kod blokları oluşur:

• Bu bloklarda kopyalama ve yapıştırma işlemi gerçekleştirebilirsiniz.
• Bu bloklar arama motorları tarafından dizine alınır.
• Bu bloklara ekran okuyucularla erişim sağlanabilir.

Bunlar, makaleye kod ekleme yöntemi olarak IDE ekran görüntülerinin önerilmemesinin nedenlerinden bazılarıdır. Kod için IDE ekran görüntülerini yalnızca IntelliSense gibi IDE özelliklerini göstermek için kullanın. Yalnızca renklendirmeyi ve vurgulamayı göstermek için ekran görüntülerini kullanmayın.

Kod doğrulama

Bazı depolarda, tüm örnek kodlardaki hataları denetlemek için kodları otomatik olarak derleyen işlemler vardır. .NET deposu bunu yapar. Daha fazla bilgi için .NET deposundaki Katkıda Bulunma bölümüne bakın.

Başka bir depodaki kod bloklarını dahil ediyorsanız kod sahipleriyle işbirliği yaparak kod için bir bakım stratejisi belirleyin. Bu sayede kodun kullandığı kitaplıkların yeni sürümleri çıktığında eklediğiniz kod çalışmayı durdurmaz veya geçersiz olmaz.

Vurgulama

Kod parçacıkları genelde bağlam sağlamak amacıyla gerekenden daha fazla kod içerir. Kod parçacığında odaklandığınız önemli satırları vurgulamanız, okunurluk için faydalı olacaktır. Örneğin:

Kodu makale Markdown dosyasına eklediğinizde vurgulayamazsınız. Bu yalnızca kod dosyasına başvuru ile eklenen kod parçacıkları için geçerlidir.

Yatay kaydırma çubukları

Yatay kaydırma çubuklarını önlemek için uzun satırları bölün. Kod bloklarında kaydırma çubukları, kodun okunmasını zorlaştırır. Çubuklar özellikle uzun kod bloklarında sorun yaratır, okumak istediğiniz satırla kaydırma çubuğu üst üste gelebilir.

Kod bloklarında yatay kaydırma çubuklarını en aza indirmek için iyi bir uygulama, 85 karakterden uzun kod satırlarını bölmektir. Ancak kaydırma çubuğunun mevcut olup olmamasının tek okunabilirlik ölçütü olmadığını unutmayın. Bir satırı 85 karakterden önce bölmek okunabilirliği veya kopyala/yapıştır imkanını olumsuz etkiliyorsa 85 karakteri geçebilirsiniz.

Hatalı kodu açık bir şekilde tanımla

Bazı senaryolarda, kaçınılması gereken kodlama desenlerinin işaret etmesi yararlı olur, örneğin:

• Denendiğinde derleyici hatasına neden olacak kod.
• Doğru derlenecek, ancak önerilmez.

Bu senaryolar için:

• Hatayı kod açıklamalarında ve makale metninde açıklayın.

  Okuyucular genellikle makale metnini atlar ve yalnızca kod üzerinde görünür, bu nedenle hatayı yalnızca makale metninde açıklamak yeterli değildir. Kod açıklamaları yerelleştirilmemiş olduğundan, hatayı yalnızca kod açıklamalarında açıklamak da yeterli değildir.

• Derleyici hatasına neden olacaksa kodu açıklamaya alma.

  Makalenin reposunda şu anda bir kod varsa veya gelecekte bir kod uygulanırsa, açıklamalı kod sürekli tümleştirme (CI) sistemini kesintiye neden olmayacaktır.

Önerilmez kod sunmak için bkz. Rune kullanım örneği: harf büyük/harfini değiştirme. Bu örnekte, C# yöntem adı olduğu için kodun içinde bile yerleşik olarak kaçınılması önerisinde ConvertToUpperBadExample edilmiştir.

Satır içi kod blokları

Satır içi kod bloklarını yalnızca kodu bir kod dosyasına başvuru olarak göstermek pratik değilse kullanın. Tam kapsamlı bir projenin parçası olan bir kod dosyasıyla karşılaştırıldığında satır içi kodu test etmek ve güncel tutmak genellikle daha zordur. Ayrıca satır içi kod, geliştiricinin kodu anlamasına ve kullanmasına yardımcı olabilecek bağlamdan ayrılmış olabilir. Bu durumlar genellikle programlama dilleri için geçerlidir. Satır içi kod blokları ayrıca çıkışlar ve girişler (JSON gibi), sorgu dilleri (SQL gibi) ve betik oluşturma dilleri (PowerShell gibi) için kullanılabilir.

Makaledeki bir kısım metnin kod bloğu olduğunu göstermenin iki yolu vardır: metni üçlü ters tik (```) ile çitlemek veya girintilemek. Çitlemek daha tercih edilen bir yöntemdir çünkü dili belirtmenize izin verir. Hata yapma olasılığı yüksek olduğundan ve makalenizi düzenlemek isteyen başka bir yazarın niyetinizi anlaması zor olabileceğinden girintileme kullanmaktan kaçının.

Dil göstergeleri, üçlü ters tik açar açmaz aşağıdaki örnekteki gibi yerleştirilir:

Markdown:

    ```json
    {
        "aggregator": {
            "batchSize": 1000,
            "flushTimeout": "00:00:30"
        }
    }
    ```

İşlenmiş:

{
    "aggregator": {
        "batchSize": 1000,
        "flushTimeout": "00:00:30"
    }
}

Dil göstergesi olarak kullanabileceğiniz değerler hakkında bilgi için bkz. Dil adları ve diğer adları.

Üçlü ters tırnaktan (```) sonra desteklenmeyen bir dil veya ortam sözcüğü kullanırsanız ilgili sözcük işlenen sayfanın başlık çubuğunun kod bölümünde görünür. Mümkün olduğunda satır içi kod bloklarında bir dil veya ortam göstergesi kullanın.

Depo içi kod parçacığı başvuruları

Belgelere programlama dilleri için kod parçacıkları eklemenin tercih edilen yolu, bir kod dosyasına başvuru vermektir. Bu yöntem, kod satırlarını vurgulama imkanı sunar ve geliştiricilerin kod parçacığı için GitHub'da bulunan daha geniş bağlamı kullanmalarını sağlar. El ile kod eklemek için üç tane iki nokta üst üste biçimini (:::) kullanabilir veya Visual Studio Code'da docs.microsoft.com Yazma Paketi'ni kullanabilirsiniz.

1. Visual Studio Code’da Alt + M veya Option + M kısayoluna tıklayın ve Kod parçacığını seçin.
2. Kod parçacığı seçildikten sonra Tam Arama, Kapsamlı Arama veya Depolar Arası Başvuru seçeneklerinden birini belirlemeniz istenir. Yerel olarak aramak için Tam Arama seçeneğini belirleyin.
3. Dosyayı bulmak için bir arama terimi girin. Dosyayı bulduktan sonra seçin.
4. Ardından, hangi kod satırlarının kod parçacığına ekleneceğini belirtmek için seçeneklerden birini belirleyin. Seçenekler şunlardır: Kimlik, Aralık ve Hiçbiri.
5. 4. adımdaki seçiminizi temel alarak, gerekirse bir değer sağlayın.

Bütün kod dosyasını görüntüleme:

:::code language="csharp" source="intro/samples/cu/Controllers/StudentsController.cs":::

Satır numaraları belirterek kod dosyasının bir kısmını görüntüleme:

:::code language="csharp" source="intro/samples/cu/Controllers/StudentsController.cs" range="2-24,26":::

Kod parçacığı adı belirterek kod dosyasının bir kısmını görüntüleme:

:::code language="csharp" source="intro/samples/cu/Controllers/StudentsController.cs" id="snippet_Create":::

Aşağıdaki bölümler bu örnekleri açıklamaktadır:

• Kod dosyası için bir göreli yol kullanma
• Yalnızca seçili satır numaralarını dahil etme
• Adlandırılmış bir kod parçasına başvurma
• Seçili satırları vurgulama

Daha fazla bilgi için bu makalenin devamındaki Kod parçacığı söz dizimi başvurusu bölümüne bakın.

Kod dosyası yolu

Örnek:

:::code language="csharp" source="intro/samples/cu/Controllers/StudentsController.cs" range="2-24,26":::

Örnek, ASP.NET belgeleri deposundaki aspnetcore/data/ef-mvc/crud.md makalesinin dosyasındandır. Kod dosyasına aynı depodaki aspnetcore/data/ef-mvc/intro/samples/cu/Controllers/StudentsController.cs göreli yolu tarafından başvurulmuştur.

Seçili satır numaraları

Örnek:

:::code language="csharp" source="intro/samples/cu/Controllers/StudentsController.cs" range="2-24,26":::

Bu örnek, StudentController.cs kod dosyasının yalnızca 2-24 ve 26. satırlarını görüntüler.

Gelecek bölümde açıklanacağı üzere sabit kodlanmış satır numaraları yerine adlandırılmış kod parçacıklarını tercih edin.

Adlandırılmış kod parçacığı

Örnek:

:::code language="csharp" source="intro/samples/cu/Controllers/StudentsController.cs" id="snippet_Create":::

Ad için yalnızca harf ve alt çizgi kullanın.

Örnek, kod dosyasının snippet_Create bölümünü göstermektedir. Bu örneğin kod dosyasında C# kodunda açıklama olarak kod parçacığı etiketleri bulunmaktadır:

// code excluded from the snippet
// <snippet_Create>
// code included in the snippet
// </snippet_Create>
// code excluded from the snippet

Adlandırılmış kod parçacıkları aşağıdaki örnekte gösterildiği gibi iç içe yerleştirilebilir:

// <Method>
public static void SomeMethod()
{
    // <Line>
    // Single line of code.
    // </Line>
}
// </Method>

Kod Method parçacığı işlenecek Line olduğunda, etiketler işlenmiş çıkışa dahil değildir.

Mümkün olduğunca satır numarası belirtmek yerine adlandırılmış bir bölüme başvurun. Satır numarası başvuruları çok güvenilir değildir çünkü kod dosyalarının ve dolayısıyla satır numaralarının değişmesi kaçınılmazdır. Bu tür değişiklikler için ise size bir bildirim yapılmaz. Bir gün makalenizde yanlış satırlar gösterilmeye başlar ve sizin bu değişikliklere dair bir fikriniz olmaz.

Seçili satırları vurgulama

Örnek:

:::code language="csharp" source="intro/samples/cu/Controllers/StudentsController.cs" range="2-24,26" highlight="2,5":::

Bu örnekte, görüntülenen kod parçacığının başından itibaren 2. ve 5. satırlar vurgulanmaktadır. Vurgulanacak satır numaraları, kod dosyasının başından itibaren sayılmaz. Yani kod dosyasının 3. ve 6. satırları vurgulanmaktadır.

Depo dışı kod parçacığı başvuruları

Başvurmak istediğiniz kod dosyası başka bir depodaysa, kod deposunu bağımlı depo olarak ayarlayın. Bunu yaptığınızda depo için bir ad belirtirsiniz. Daha sonra bu ad, kod başvurusu amacıyla klasör adı gibi davranır.

Örneğin belge deposu Azure/azure-docs, ve kod deposu Azure/azure-functions-durable-extension olsun.

azure-docs kök klasöründeki .openpublishing.publish.config.json dosyasına şu kısmı ekleyin:

    {
      "path_to_root": "samples-durable-functions",
      "url": "https://github.com/Azure/azure-functions-durable-extension",
      "branch": "master",
      "branch_mapping": {}
    },

Artık samples-durable-functions’a azure-docs’taki bir klasörmüş gibi başvurduğunuzda aslında azure-functions-durable-extension deposundaki kök klasöre başvurmuş olacaksınız.

El ile kod eklemek için üç tane iki nokta üst üste biçimini (:::) kullanabilir veya Visual Studio Code'da docs.microsoft.com Yazma Paketi'ni kullanabilirsiniz.

1. Visual Studio Code’da Alt + M veya Option + M kısayoluna tıklayın ve Kod parçacığını seçin.
2. Kod parçacığı seçildikten sonra Tam Arama, Kapsamlı Arama veya Depolar Arası Başvuru seçeneklerinden birini belirlemeniz istenir. Depolar arası arama yapmak için Depolar Arası Başvuru seçeneğini belirleyin.
3. .openpublishing.publish.config.json’da yer alan depolar sunulur. Depo seçin.
4. Dosyayı bulmak için bir arama terimi girin. Dosyayı bulduktan sonra seçin.
5. Ardından, hangi kod satırlarının kod parçacığına ekleneceğini belirtmek için seçeneklerden birini belirleyin. Seçenekler şunlardır: Kimlik, Aralık ve Hiçbiri.
6. 5. adımdaki seçiminizi temel alarak bir değer sağlayın.

Kod parçacığı başvurunuz şöyle görünür:

:::code language="csharp" source="~/samples-durable-functions/samples/csx/shared/Location.csx" highlight="2,5":::

azure-functions-durable-extension deposunda bu kod, samples/csx/shared klasöründedir. Daha önce belirtildiği üzere vurgulama için kullanılan satır sayıları için dosyanın başlangıcı değil kod parçacığının başlangıcı temel alınır.

Jupyter not defterindeki kod parçacıkları

Jupyter not defterindeki bir hücreye kod parçacığı olarak başvurabilirsiniz. Hücreye başvuru yapmak için:

1. Başvuru yapmak istediğiniz hücreler için not defterine hücre meta verileri ekleyin.
2. Depoya erişimi ayarlayın.
3. Markdown dosyanız içinde Jupyter not defteri kod parçacığı söz dizimi kullanın.

Meta verileri not defterine ekle

1. Jupyter not defterine hücre meta verileri ekleyerek hücreyi adlandırın.

   • Jupyter 'da, önce hücre araç çubuğunu etkinleştirerek hücre meta verilerini düzenleyebilirsiniz : > hücre araç çubuğunu görüntüleyin > meta verileri düzenleyin.
   • Hücre araç çubuğu etkinleştirildikten sonra, adlandırmak istediğiniz hücrede meta verileri Düzenle ' yi seçin.
   • Ya da meta verileri doğrudan not defteri JSON yapısında düzenleyebilirsiniz.

2. Hücre meta verilerinde "ad" özniteliği ekleyin:

   "metadata": {"name": "<name>"},
   

   Örnek:

   "metadata": {"name": "workspace"},
   

   İpucu

   Hücrenin nerede kullanıldığını izlemenize yardımcı olmak istediğiniz diğer meta verileri ekleyebilirsiniz. Örnek:

       "metadata": {
         "name": "workspace",
         "msdoc": "how-to-track-experiments.md"
       },
   

Depo erişimini ayarlama

Başvurmak istediğiniz Not defteri dosyası farklı bir depoda ise, kod deposunu bağımlı bir depoolarak ayarlayın.

Jupyter Notebook parçacığı sözdizimi başvurusu

Not defteriniz gerekli meta verileri içerdiğinde, markı dosyanızda bu dosyaya başvurun. <cell-name-value>Not defterine eklediğiniz öğesini kullanın ve <path> bağımlı deponuz olarak ayarlayın.

[!notebook-<language>[] (<path>/<notebook-name.ipynb>?name=<cell-name-value>)]

Örnek:

[!notebook-python[] (~/MachineLearningNotebooks/train-on-local.ipynb?name=workspace)]

Tanımlayıcı için desteklenen dillerden herhangi birini kullanın <language> .

Etkileşimli kod parçacıkları

Satır içi etkileşimli kod blokları

Şu diller için kod parçacıkları, tarayıcı penceresinde yürütülebilir hale getirilebilir:

• Azure Cloud Shell
• Azure PowerShell Cloud Shell
• C# REPL

Etkileşimli mod etkinleştirildiğinde işlenmiş kod kutularında Dene veya Çalıştır düğmesi bulunur. Örneğin:

    ```azurepowershell-interactive
    New-AzResourceGroup -Name myResourceGroup -Location westeurope
    ```

şu şekilde işlenir:

New-AzResourceGroup -Name myResourceGroup -Location westeurope

And

    ```csharp-interactive
    var aFriend = "Maria";
    Console.WriteLine($"Hello {aFriend}");
    ```

şöyle işler:

    var aFriend = "Maria";
    Console.WriteLine($"Hello {aFriend}");

Belirli bir kod bloğunda bu özelliği açmak için özel bir dil tanımlayıcısı kullanın. Şu seçenekler sağlanır:

• azurepowershell-interactive - Yukarıdaki örnekte olduğu gibi Azure PowerShell Cloud Shell’i etkinleştirir
• azurecli-interactive - Azure Cloud Shell’i etkinleştirir
• csharp-interactive - C# REPL'yi etkinleştirir

Azure Cloud Shell ve PowerShell Cloud Shell için kullanıcılar, yalnızca kendi Azure hesaplarında komutlar çalıştırabilirler.

Başvuruyla dahil edilen kod parçacıkları

Bir başvuruda bulunan kod parçacıkları için etkileşimli modu etkinleştirebilirsiniz. Belirli bir kod bloğunda bu özelliği açmak için interactive özniteliğini kullanın. Kullanılabilir öznitelik değerleri şunlardır:

• cloudshell-powershell - Yukarıdaki örnekte olduğu gibi Azure PowerShell Cloud Shell’i etkinleştirir
• cloudshell-bash - Azure Cloud Shell’i etkinleştirir
• try-dotnet - Try .NET’i etkinleştirir
• try-dotnet-class - Sınıf yapı iskelesi ile Try .NET’i etkinleştirir
• try-dotnet-method - Metot yapı iskelesi ile Try .NET’i etkinleştirir

İşte bazı örnekler:

:::code source="PowerShell.ps1" interactive="cloudshell-powershell":::

:::code source="Bash.sh" interactive="cloudshell-bash":::

Azure Cloud Shell ve PowerShell Cloud Shell için kullanıcılar, yalnızca kendi Azure hesaplarında komutlar çalıştırabilirler.

.NET Interactive deneyiminde kod bloğunuzun içeriği, aşağıdaki üç yapı iskelesi arasından yaptığınız seçime göre değişir:

• Yapı iskelesi yok (try-dotnet): Kod bloğu, tam kapsamlı bir program metnini temsil etmelidir. Örneğin dotnet new console tarafından oluşturulan Program.cs dosyası geçerli olur. Bunlar, gerekli using yönergeleri dahil olmak üzere küçük bir programın tamamını gösterme açısından faydalıdır. Üst düzey deyimler şu an için desteklenmez.
• Yöntem yapı iskelesi (try-dotnet-method): Kod bloğu, bir konsol uygulamasındaki Main yönteminin içeriğini temsil etmelidir. dotnet new console şablonu tarafından eklenen using yönergeleri örnek olarak verilebilir. Bu ayar, tek bir özelliği gösteren kısa kod parçacıkları için faydalıdır.
• Sınıf yapı iskelesi (try-dotnet-class): Kod bloğu, program giriş noktası olarak Main yöntemine sahip bir sınıfı temsil etmelidir. Bunlar bir sınıfın üyelerinin nasıl etkileşim kurduğunu göstermek için kullanılabilir.

Kod parçacığı söz dizimi başvurusu

Söz dizimi:

:::code language="<language>" source="<path>" <attribute>="<attribute-value>":::

• <language> (isteğe bağlı)

  • Kod parçacığının dili. Daha fazla bilgi için bu makalenin ilerleyen bölümlerinde yer alan Desteklenen diller bölümüne bakın.

• <path> (zorunlu)

  • Dosya sisteminde, başvurulacak kod parçacığı dosyasını gösteren göreli yol.

• <attribute> ve <attribute-value> (isteğe bağlı)

  • Kodun dosyadan nasıl alınacağını ve nasıl görüntüleneceğini belirtmek için birlikte kullanın:
    • range: 1,3-5 Satır aralığı. Bu örnek 1, 3, 4 ve 5. satırları ekler.
    • id: Create Kod dosyasından eklenmesi gereken kod parçacığının kimliği. Bu değer, aralıkla birlikte bulunamaz.
    • highlight: 2-4,6 Oluşturulan kod parçacığında vurgulanması gereken aralık ve/veya satır sayısı. Numaralandırma, dosyaya değil görüntülenecek satırlara (aralığa veya kimliğe göre belirtilen şekilde) göre belirlenir.
    • interactive: cloudshell-powershell, cloudshell-bash, try-dotnet, try-dotnet-class, try-dotnet-method Dize değeri ne türden etkileşimlerin etkinleştirildiğini belirler.
    • Dile göre kod parçacığı kaynak dosyalarındaki etiket adı gösterimi hakkında ayrıntılı bilgi için, DocFX yönergelerine bakın.

Desteklenen diller

Docs Yazma Paketi, çevrelenmiş kod blokları için kullanılabilir dil tanımlayıcılarına yönelik deyim tamamlama ve doğrulama sağlayan bir özellik sunar.

Çevrelenmiş kod blokları

Sonraki adımlar

Kod dışındaki içerik türlerine yönelik metin biçimlendirme hakkında daha fazla bilgi için bkz. Metin biçimlendirme yönergeleri.