Baca dalam bahasa Inggris

Bagikan melalui


Cara menyertakan kode dalam dokumentasi

Ada beberapa cara selain cuplikan layar untuk menyertakan kode dalam artikel yang diterbitkan di Microsoft Learn:

  • Elemen individual (kata- kata) dalam satu baris.

    Berikut adalah contoh code gaya.

    Gunakan format kode saat merujuk ke parameter dan variabel bernama dalam blok kode terdekat dalam teks Anda. Format kode juga dapat digunakan untuk properti, metode, kelas, dan kata kunci bahasa. Untuk informasi selengkapnya, lihat Elemen kode nanti di artikel ini..

  • Blok kode dalam artikel File markdown.

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

    Gunakan blok kode sebaris saat tidak praktis untuk menampilkan kode dengan mereferensikan ke file kode. Untuk informasi selengkapnya, lihat Blok kode nanti di artikel ini.

  • Blok kode dengan mereferensikan ke file kode di repositori lokal.

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

    Untuk informasi selengkapnya, lihat Referensi cuplikan dalam repo nanti di artikel ini.

  • Kode memblokir dengan mereferensikan ke file kode di repositori lain.

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

    Untuk informasi selengkapnya, lihat Referensi cuplikan di luar repo nanti di artikel ini.

  • Blok kode yang memungkinkan pengguna menjalankan kode di browser.

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

    Untuk informasi selengkapnya, lihat Cuplikan kode interaktif nanti di artikel ini.

Selain menjelaskan Markdown untuk masing-masing cara ini untuk menyertakan kode, artikel ini menyediakan beberapa panduan umum untuk semua blok kode.

Elemen kode

"Elemen kode" adalah kata kunci bahasa pemrograman, nama kelas, nama properti, dan sebagainya. Tidak selalu jelas apa yang memenuhi syarat sebagai kode. Misalnya, nama paket NuGet harus diperlakukan sebagai kode. Jika ragu, lihat Panduan pemformatan teks.

Gaya kode sebaris

Untuk menyertakan elemen kode dalam teks artikel, kelilingi dengan backticks (') untuk menunjukkan gaya kode. Gaya kode sebaris tidak boleh menggunakan format triple-backtick.

Markdown Diberikan
Secara default, Kerangka Kerja Entitas menginterpretasikan properti yang bernama 'Id' atau 'ClassnameID' sebagai kunci utama. Secara default, Kerangka Kerja Entitas menginterpretasikan properti yang dinamai Id atau ClassnameID sebagai kunci utama.

Saat artikel dilokalkan (diterjemahkan ke dalam bahasa lain), teks yang ditata sebagai kode dibiarkan tidak diterjemahkan. Jika Anda ingin mencegah pelokalan tanpa menggunakan gaya kode, lihat String yang tidak dilokalkan.

Gaya tebal

Beberapa panduan gaya lama menentukan tebal untuk kode sebaris. Tebal adalah opsi ketika gaya kode sangat mengganggu untuk membahayakan keterbacaan. Misalnya, tabel Markdown dengan sebagian besar elemen kode mungkin terlihat terlalu sibuk dengan gaya kode di mana-mana. Jika Anda memilih untuk menggunakan gaya tebal, gunakan sintaksis string yang tidak dilokalkan untuk memastikan bahwa kode tidak dilokalkan.

Tautan ke dokumentasi referensi mungkin lebih membantu daripada format kode dalam beberapa konteks. Jika Anda menggunakan tautan, jangan terapkan format kode ke teks tautan. Menata tautan sebagai kode dapat mengaburkan fakta bahwa teks adalah tautan.

Jika Anda menggunakan tautan dan merujuk ke elemen yang sama nanti dalam konteks yang sama, buat format kode instans berikutnya daripada tautan. Misalnya:

The first reference to <xref:System.CommandLine> in this text is a link.
Subsequent references to `System.CommandLine` can be in code style.

Diberikan:

Referensi pertama ke System.CommandLine dalam teks ini adalah tautan. Referensi berikutnya dapat System.CommandLine dalam gaya kode.

Tempat penampung

Jika Anda ingin pengguna mengganti bagian kode yang ditampilkan dengan nilainya sendiri, gunakan teks tempat penampung yang ditandai oleh tanda kurung sudut. Misalnya:

az group delete -n <ResourceGroupName>

Anda mungkin mencatat bahwa tanda kurung harus dihapus saat mengganti nilai nyata. Panduan Gaya Penulisan Microsoft memanggil miring, yang dapat Anda format dalam kode sebaris kurung sudut:

<ResourceGroupName> adalah grup sumber daya di mana...

Kurung kurawal { } tidak disarankan untuk digunakan sebagai tempat penampung sintis. Mereka mungkin bingung dengan notasi yang sama yang digunakan dalam teks yang dapat diganti, string format, interpolasi string, templat teks, dan konstruksi pemrograman serupa.

Nama tempat penampung dapat dipisahkan oleh tanda hubung ("kasus kebab"), dengan garis bawah, atau tidak dipisahkan sama sekali (kasus Pascal). Kasus Kebab dapat menghasilkan kesalahan sintaksis dan garis bawah dapat bertentangan dengan garis bawah. Semua huruf besar mungkin berkonflik dengan konstanta bernama dalam banyak bahasa, meskipun mungkin juga menarik perhatian pada nama tempat penampung.

<Resource-Group-Name> atau <ResourceGroupName>

Blok kode

Sintaks untuk menyertakan kode dalam dokumen bergantung pada tempat kode berada:

Berikut adalah panduan yang berlaku untuk ketiga jenis blok kode:

Cuplikan layar

Semua metode yang tercantum di bagian sebelumnya menghasilkan blok kode yang dapat digunakan:

  • Anda dapat menyalin dan menempelkannya.
  • Mereka diindeks oleh mesin pencari.
  • Mereka dapat diakses oleh pembaca layar.

Ini hanya beberapa alasan mengapa cuplikan layar IDE tidak disarankan sebagai metode menyertakan kode dalam artikel. Gunakan cuplikan layar IDE untuk kode hanya jika Anda menampilkan sesuatu tentang IDE itu sendiri, seperti IntelliSense. Jangan gunakan cuplikan layar hanya untuk menampilkan pewarnaan dan penyorotan.

Validasi kode

Beberapa repositori telah menerapkan proses yang secara otomatis mengkompilasi semua kode sampel untuk memeriksa kesalahan. Repositori .NET melakukan ini. Untuk informasi selengkapnya, lihat Berkontribusi di repositori .NET.

Jika Anda menyertakan blok kode dari repositori lain, bekerja dengan pemilik pada strategi pemeliharaan untuk kode sehingga kode yang disertakan tidak rusak atau kedaluarsa karena versi baru pustaka yang digunakan kode dikirim.

Menyoroti

Cuplikan biasanya menyertakan lebih banyak kode daripada yang diperlukan untuk memberikan konteks. Ini membantu keterbacaan saat Anda menyoroti baris kunci yang Anda fokuskan dalam cuplikan, seperti dalam contoh ini:

Example showing highlighted code

Anda tidak dapat menyoroti kode saat menyertakannya dalam artikel File markdown. Ini hanya berfungsi untuk cuplikan kode yang disertakan dengan referensi ke file kode.

Bilah gulir horizontal

Putuskan garis panjang untuk menghindari bilah gulir horizontal. Bilah gulir pada blok kode membuat kode sulit dibaca. Mereka sangat bermasalah pada blok kode yang lebih panjang, di mana mungkin tidak mungkin untuk melihat bilah gulir dan baris yang ingin Anda baca secara bersamaan.

Praktik yang baik untuk meminimalkan bilah gulir horizontal pada blok kode adalah memecah baris kode lebih dari 85 karakter. Tetapi perlu diingat bahwa kehadiran atau tidak adanya bilah gulir bukanlah satu-satunya kriteria keterbacaan. Jika melanggar garis sebelum 85 menyakiti keterbacaan atau kenyamanan salin-tempel, jangan ragu untuk pergi lebih dari 85.

Mengidentifikasi kode buruk dengan jelas

Dalam beberapa skenario, sangat membantu untuk menunjukkan pola pengkodian yang harus dihindari, misalnya:

  • Kode yang akan menyebabkan kesalahan kompilator jika dicoba.
  • Kode yang akan dikompilasi dengan benar tetapi tidak disarankan.

Untuk skenario ini:

  • Jelaskan kesalahan baik dalam komentar kode maupun teks artikel.

    Pembaca sering melewati teks artikel dan hanya melihat kode, sehingga tidak cukup untuk menjelaskan kesalahan hanya dalam teks artikel. Ini juga tidak cukup untuk menjelaskan kesalahan hanya dalam komentar kode, karena komentar kode tidak dilokalkan.

  • Pertimbangkan untuk mengomentari kode jika akan menyebabkan kesalahan kompilator.

    Kode yang dikomentari tidak akan mengganggu sistem integrasi berkelanjutan (CI) jika repositori artikel memilikinya sekarang atau mengimplementasikannya di masa mendatang.

Untuk contoh cara menyajikan kode yang tidak disarankan, lihat Contoh penggunaan rune: mengubah huruf besar/kecil. Dalam contoh ini, saran untuk menghindarinya bahkan dibangun ke dalam kode itu sendiri, karena nama metode C# adalah ConvertToUpperBadExample.

Blok kode sebaris

Gunakan blok kode sebaris hanya ketika tidak praktis untuk menampilkan kode dengan mereferensikan ke file kode. Kode sebaris umumnya lebih sulit diuji dan diperbarui dibandingkan dengan file kode yang merupakan bagian dari proyek lengkap. Dan kode sebaris dapat menghilangkan konteks yang dapat membantu pengembang untuk memahami dan menggunakan kode. Pertimbangan ini terutama berlaku untuk bahasa pemrograman. Blok kode sebaris juga dapat digunakan untuk output dan input (seperti JSON), bahasa kueri (seperti SQL), dan bahasa skrip (seperti PowerShell).

Ada dua cara untuk menunjukkan bagian teks dalam file artikel adalah blok kode: dengan menggabungkannya dalam triple-backtick (''' ) atau dengan mengindentasinya. Anggar lebih disukai karena memungkinkan Anda menentukan bahasa. Hindari menggunakan indentasi karena terlalu mudah untuk salah dan mungkin sulit bagi penulis lain untuk memahami niat Anda ketika mereka perlu mengedit artikel Anda.

Indikator bahasa ditempatkan segera setelah pembukaan triple-backtick, seperti dalam contoh berikut:

Markdown:

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

Diberikan:

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

Tip

GitHub Flavored Markdown mendukung pembatas blok kode dengan tilde (~) serta dengan backtick ('). Simbol yang digunakan untuk membuka dan menutup blok kode harus konsisten dalam blok kode yang sama.

Untuk informasi tentang nilai yang bisa Anda gunakan sebagai indikator bahasa, lihat Nama bahasa dan alias.

Jika Anda menggunakan kata bahasa atau lingkungan setelah triple-backticks (''') yang tidak didukung, kata tersebut muncul di bilah judul bagian kode di halaman yang dirender. Jika memungkinkan, gunakan indikator bahasa atau lingkungan di blok kode sebaris Anda.

Catatan

Jika Anda menyalin dan menempelkan kode dari dokumen Word, pastikan tidak memiliki "tanda kutip keriting", yang tidak valid dalam kode. Jika ya, ubah kembali ke tanda kutip normal (' dan "). Atau, mengandalkan Learn Authoring Pack, fitur penggantian kutipan pintar.

Referensi cuplikan dalam repo

Cara yang disukai untuk menyertakan cuplikan kode untuk bahasa pemrograman dalam dokumen adalah dengan merujuk ke file kode. Metode ini memberi Anda kemampuan untuk menyoroti baris kode dan membuat konteks cuplikan yang lebih luas tersedia di GitHub untuk digunakan pengembang. Anda dapat menyertakan kode dengan menggunakan format titik dua tiga (:::) secara manual atau di Visual Studio Code dengan bantuan Learn Authoring Pack.

  1. Di Visual Studio Code, klik Alt + M atau Opsi + M dan pilih Cuplikan.
  2. Setelah Cuplikan dipilih, Anda akan diminta untuk Pencarian Penuh, Pencarian Tercakup, atau Referensi Lintas Repositori. Untuk mencari secara lokal, pilih Pencarian Penuh.
  3. Masukkan istilah pencarian untuk menemukan file. Setelah Anda menemukan file, pilih file .
  4. Selanjutnya, pilih opsi untuk menentukan baris kode mana yang harus disertakan dalam cuplikan. Opsinya adalah: ID, Rentang, dan Tidak Ada.
  5. Berdasarkan pilihan Anda dari Langkah 4, berikan nilai jika perlu.

Tampilkan seluruh file kode:

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

Tampilkan bagian dari file kode dengan menentukan nomor baris:

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

Tampilkan bagian dari file kode dengan menentukan nama cuplikan:

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

Bagian berikut menjelaskan contoh-contoh ini:

Untuk informasi selengkapnya, lihat Referensi sintaks cuplikan nanti di artikel ini.

Jalur ke file kode

Contoh:

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

Contohnya adalah dari file artikel ASP.NET docs, aspnetcore/data/ef-mvc/crud.md . File kode direferensikan oleh jalur relatif ke aspnetcore/data/ef-mvc/intro/samples/cu/Controllers/StudentsController.cs di repositori yang sama.

Nomor baris terpilih

Contoh:

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

Contoh ini hanya menampilkan baris 2-24 dan 26 dari file kode StudentController.cs .

Lebih suka cuplikan bernama daripada nomor baris yang dikodekan secara permanen, seperti yang dijelaskan di bagian berikutnya.

Cuplikan bernama

Contoh:

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

Gunakan hanya huruf dan garis bawah untuk nama tersebut.

Contoh menampilkan bagian snippet_Create file kode. File kode untuk contoh ini memiliki tag cuplikan dalam komentar dalam kode C#:

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

Cuplikan kode bernama dapat ditumpuk, seperti yang ditunjukkan dalam contoh berikut:

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

Method Saat cuplikan kode dirender, Line tag tidak disertakan dalam output yang dirender.

Setiap kali Anda bisa, lihat bagian bernama daripada menentukan nomor baris. Referensi nomor baris rapuh karena file kode pasti berubah dengan cara yang membuat nomor baris berubah. Anda belum tentu mendapatkan pemberitahuan tentang perubahan tersebut. Artikel Anda akhirnya mulai menunjukkan baris yang salah dan Anda tidak memiliki petunjuk apa pun yang telah berubah.

Menyoroti baris terpilih

Contoh:

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

Contoh menyoroti garis 2 dan 5, dihitung dari awal cuplikan yang ditampilkan. Nomor baris yang akan disorot tidak dihitung dari awal file kode. Dengan kata lain, baris 3 dan 6 file kode disorot.

Referensi cuplikan di luar repo

Jika file kode yang ingin Anda referensikan berada di repositori yang berbeda, siapkan repositori kode sebagai repositori dependen. Saat Anda melakukannya, Anda menentukan nama untuk itu. Nama itu kemudian bertindak seperti nama folder untuk tujuan referensi kode.

Misalnya, repositori dokumen adalah Azure/azure-docs, dan repositori kodenya adalah Azure/azure-functions-durable-extension.

Di folder akar azure-docs, tambahkan bagian berikut di .openpublishing.publish.config.json:

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

Sekarang ketika Anda merujuk ke samples-durable-functions seolah-olah itu adalah folder di azure-docs, Anda benar-benar merujuk ke folder akar di repositori azure-functions-durable-extension .

Anda dapat menyertakan kode dengan menggunakan format titik dua tiga (:::) secara manual atau di Visual Studio Code dengan bantuan Learn Authoring Pack.

  1. Di Visual Studio Code, klik Alt + M atau Opsi + M dan pilih Cuplikan.
  2. Setelah Cuplikan dipilih, Anda akan diminta untuk Pencarian Penuh, Pencarian Tercakup, atau Referensi Lintas Repositori. Untuk mencari di seluruh repositori, pilih Referensi Lintas Repositori.
  3. Anda akan diberikan pilihan repositori yang ada di .openpublishing.publish.config.json. Pilih repositori.
  4. Masukkan istilah pencarian untuk menemukan file. Setelah Anda menemukan file, pilih file .
  5. Selanjutnya, pilih opsi untuk menentukan baris kode mana yang harus disertakan dalam cuplikan. Opsinya adalah: ID, Rentang, dan Tidak Ada.
  6. Berdasarkan pilihan Anda dari Langkah 5, berikan nilai.

Referensi cuplikan Anda akan terlihat seperti ini:

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

Di repositori azure-functions-durable-extension, file kode tersebut berada di folder samples/csx/shared. Seperti disebutkan sebelumnya, nomor baris untuk penyorotan relatif terhadap awal cuplikan daripada awal file.

Catatan

Nama yang Anda tetapkan ke repositori dependen relatif terhadap akar repositori utama, tetapi tilde (~) mengacu pada akar docset. Akar docset ditentukan oleh build_source_folder dalam .openpublishing.publish.config.json. Jalur ke cuplikan dalam contoh sebelumnya berfungsi di repositori azure-docs karena build_source_folder mengacu pada akar repositori (.). Jika build_source_folder adalah articles, jalur akan dimulai dengan ~/../samples-durable-functions alih-alih ~/samples-durable-functions.

Cuplikan dalam buku catatan Jupyter

Anda bisa mereferensikan sel di buku catatan Jupyter sebagai cuplikan kode. Untuk mereferensikan sel:

  1. Tambahkan metadata sel ke buku catatan untuk sel yang ingin Anda referensikan.
  2. Siapkan akses ke repositori.
  3. Gunakan sintaksis cuplikan notebook Jupyter dalam file markdown Anda.

Menambahkan metadata ke buku catatan

  1. Beri nama sel dengan menambahkan metadata sel di buku catatan Jupyter.

    • Di Jupyter, Anda dapat mengedit metadata sel dengan terlebih dahulu mengaktifkan toolbar sel: Tampilkan > Toolbar > Sel Edit Metadata.
    • Setelah toolbar sel diaktifkan, pilih Edit Metadata pada sel yang ingin Anda beri nama.
    • Atau Anda dapat mengedit metadata langsung di struktur JSON buku catatan.
  2. Dalam metadata sel, tambahkan atribut "nama":

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

    Misalnya:

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

    Tip

    Anda dapat menambahkan metadata lain yang ingin Anda bantu melacak di mana sel sedang digunakan. Misalnya:

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

Menyiapkan akses repositori

Jika file buku catatan yang ingin Anda referensikan berada di repositori yang berbeda, siapkan repositori kode sebagai repositori dependen.

Referensi sintaks notebook Jupyter

Setelah buku catatan Anda berisi metadata yang diperlukan, referensikan dalam file markdown Anda. Gunakan yang <cell-name-value> Anda tambahkan ke buku catatan, dan <path> yang Anda siapkan sebagai repositori dependen Anda.

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

Contohnya:

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

Penting

Sintaks ini adalah ekstensi Markdown blok. Ini harus digunakan pada barisnya sendiri.

Gunakan salah satu bahasa yang didukung untuk <language> pengidentifikasi.

Cuplikan kode interaktif

Blok kode interaktif sebaris

Untuk bahasa berikut, cuplikan kode dapat dibuat dapat dieksekusi di jendela browser:

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

Saat mode interaktif diaktifkan, kotak kode yang dirender memiliki tombol Coba atau Jalankan . Misalnya:

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

dirender sebagai berikut:

New-AzResourceGroup -Name myResourceGroup -Location westeurope

Dan

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

render sebagai:

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

Untuk mengaktifkan fitur ini untuk blok kode tertentu, gunakan pengidentifikasi bahasa khusus. Opsi yang tersedia adalah:

  • azurepowershell-interactive - Mengaktifkan Azure PowerShell Cloud Shell, seperti dalam contoh sebelumnya
  • azurecli-interactive - Mengaktifkan Azure Cloud Shell
  • csharp-interactive - Mengaktifkan C# REPL

Untuk Azure Cloud Shell dan PowerShell Cloud Shell, pengguna hanya dapat menjalankan perintah terhadap akun Azure mereka sendiri.

Cuplikan kode disertakan oleh referensi

Anda dapat mengaktifkan mode interaktif untuk cuplikan kode yang disertakan oleh referensi. Untuk mengaktifkan fitur ini untuk blok kode tertentu, gunakan interactive atribut . Nilai atribut yang tersedia adalah:

  • cloudshell-powershell - Mengaktifkan Azure PowerShell Cloud Shell, seperti dalam contoh sebelumnya
  • cloudshell-bash - Mengaktifkan Azure Cloud Shell
  • try-dotnet - Mengaktifkan Coba .NET
  • try-dotnet-class - Mengaktifkan Coba .NET dengan perancah kelas
  • try-dotnet-method - Mengaktifkan Coba .NET dengan perancah metode

Berikut adalah beberapa contoh:

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

Untuk Azure Cloud Shell dan PowerShell Cloud Shell, pengguna hanya dapat menjalankan perintah terhadap akun Azure mereka sendiri.

Untuk pengalaman Interaktif .NET, konten blok kode Anda bergantung pada salah satu dari tiga pengalaman perancah yang Anda pilih:

  • Tidak ada perancah (try-dotnet): Blok kode harus mewakili teks program lengkap. Misalnya, file Program.cs yang dihasilkan oleh dotnet new console akan valid. Ini paling berguna untuk menunjukkan seluruh program kecil, termasuk arahan yang using diperlukan. Pernyataan tingkat atas saat ini tidak didukung.
  • Perancah metode (try-dotnet-method): Blok kode harus mewakili konten Main metode dalam aplikasi konsol. Anda dapat mengasumsikan arahan using yang ditambahkan oleh dotnet new console templat. Pengaturan ini paling berguna untuk cuplikan pendek yang menunjukkan satu fitur.
  • Perancah kelas (try-dotnet-class): Blok kode harus mewakili kelas dengan Main metode sebagai titik masuk program. Ini dapat digunakan untuk menunjukkan bagaimana anggota kelas berinteraksi.

Referensi sintaks cuplikan

Sintaks:

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

Penting

Sintaks ini adalah ekstensi Markdown blok. Ini harus digunakan pada barisnya sendiri.

  • <language> (opsional)

    • Bahasa cuplikan kode. Untuk informasi selengkapnya, lihat bagian Bahasa yang didukung nanti di artikel ini.
  • <path> (wajib)

    • Jalur relatif dalam sistem file yang menunjukkan file cuplikan kode untuk dirujuk.
  • <attribute> dan <attribute-value> (opsional)

    • Digunakan bersama untuk menentukan bagaimana kode harus diambil dari file dan bagaimana kode harus ditampilkan:
      • range: 1,3-5 Rentang garis. Contoh ini mencakup baris 1, 3, 4, dan 5.
      • id: Create ID cuplikan yang perlu disisipkan dari file kode. Nilai ini tidak dapat berdampingan dengan rentang.
      • highlight: 2-4,6 Rentang dan/atau jumlah baris yang perlu disorot dalam cuplikan kode yang dihasilkan. Penomoran relatif terhadap baris yang ditampilkan (seperti yang ditentukan oleh rentang atau id), bukan file.
      • interactive: cloudshell-powershell, , try-dotnetcloudshell-bash, try-dotnet-class, try-dotnet-method Nilai string menentukan jenis interaktivitas apa yang diaktifkan.
      • Untuk detail tentang representasi nama tag dalam file sumber cuplikan kode menurut bahasa, lihat panduan DocFX.

Bahasa yang didukung

Learn Authoring Pack menyertakan fitur untuk memberikan penyelesaian pernyataan dan validasi pengidentifikasi bahasa yang tersedia untuk blok pagar kode.

Blok kode pagar

Nama Alias yang valid
.NET Core CLI dotnetcli
1C 1c
ABNF abnf
Log akses accesslog
Ada ada
Perakitan ARM armasm, arm
Perakitan AVR avrasm
Actionscript actionscript, as
Alan alan, i
AngelScript angelscript, asc
ANTLR antlr
Apache apache, apacheconf
AppleScript applescript, osascript
Arcade arcade
AsciiDoc asciidoc, adoc
AspekJ aspectj
ASPX aspx
ASP.NET (C#) aspx-csharp
ASP.NET (VB) aspx-vb
AutoHotkey autohotkey
Autoit autoit
Awk awk, , mawknawk,gawk
Axapta axapta
AzCopy azcopy
Azure CLI azurecli
Azure CLI (Interaktif) azurecli-interactive
Azure Powershell azurepowershell
Azure Powershell (Interaktif) azurepowershell-interactive
Bash bash, , shzsh
Dasar basic
BNF bnf
C c
C# csharp, cs
C# (Interaktif) csharp-interactive
C++ cpp, , ccc, h, c++, , h++,hpp
C++/CX cppcx
C++/WinRT cppwinrt
C/AL cal
Cache Object Script cos, cls
CMake cmake, cmake.in
Coq coq
Csp csp
CSS css
Cap'n Proto capnproto, capnp
Clojure clojure, clj
CoffeeScript coffeescript, , coffeecson,iced
Crmsh crmsh, , crmpcmk
Crystal crystal, cr
Cypher (Neo4j) cypher
D d
DAX Power BI dax
File Zona DNS dns, , zonebind
DOS dos, , batcmd
Dart dart
Delphi delphi, , dfmdpr, pas, pascal, freepascal, lazarus, , lpr,lfm
Diff diff, patch
Django django, jinja
Dockerfile dockerfile, docker
dsconfig dsconfig
DTS (Pohon Perangkat) dts
Debu dust, dst
Dylan dylan
EBNF ebnf
Elixir elixir
Elm elm
Bahasa Erlang erlang, erl
Excel excel, , xlsxlsx
Extempore extempore, , xtlangxtm
F# fsharp, fs
PERBAIKI fix
Fortran fortran, , f90f95
G-Code gcode, nc
Gams gams, gms
GAUSS gauss, gss
GDScript godot, gdscript
Gherkin gherkin
GN untuk Ninja gn, gni
Go go, golang
Golo golo, gololang
Gradle gradle
GraphQL graphql
Groovy groovy
HTML html, xhtml
HTTP http, https
Haml haml
Setang handlebars, , hbshtml.hbs,html.handlebars
Haskell haskell, hs
Katak haxe, hx
Hy hy, hylang
Ini ini
Inform7 inform7, i7
IRPF90 irpf90
JSON json
Java java, jsp
JavaScript javascript, , jsjsx
Kotlin kotlin, kt
Kusto kusto
Daun leaf
Lasso lasso, , lslassoscript
Less less
LDIF ldif
Lisp lisp
LiveCode Server livecodeserver
LiveScript livescript, ls
Lua lua
Makefile makefile, , mkmak
Markdown markdown, , mdmkdown,mkd
Matematika mathematica, , mmawl
Matlab matlab
Maxima maxima
Bahasa Tersemat Maya mel
Merkuri mercury
Bahasa Pembuatan Skrip mIRC mirc, mrc
Mizar mizar
Format Objek Terkelola mof
Mojolicious mojolicious
Monkey monkey
Moonscript moonscript, moon
MS Graph (Interaktif) msgraph-interactive
N1QL n1ql
NSIS nsis
Nginx. nginx, nginxconf
Nimrod nimrod, nim
Nix nix
OCaml ocaml, ml
Objective C objectivec, , mmobjc,obj-c
Bahasa Bayangan OpenGL glsl
OpenSCAD openscad, scad
Bahasa Aturan Oracle ruleslanguage
Oksigen oxygene
PF pf, pf.conf
PHP php, , php3php4, , php5,php6
Parser3 parser3
Perl perl, , plpm
Teks biasa tidak ada sorotan plaintext
Pony pony
PostgreSQL & PL/pgSQL pgsql, , postgrespostgresql
PowerShell powershell, ps
PowerShell (Interaktif) powershell-interactive
Sedang diproses processing
Prolog prolog
Properti properties
Buffer Protokol protobuf
Puppet puppet, pp
Python python, , pygyp
Hasil profiler Python profile
Q# qsharp
Q k, kdb
QML qml
R r
Razor CSHTML cshtml, , razorrazor-cshtml
ReasonML reasonml, re
RenderMan RIB rib
RenderMan RSL rsl
Roboconf graph, instances
Kerangka Kerja Robot robot, rf
File spesifikasi RPM rpm-specfile, , rpmspec, , rpm-spec,specfile
Ruby ruby, , rbgemspec, podspec, , thor,irb
Rust rust, rs
SAS SAS, sas
SCSS scss
SQL sql
LANGKAH Bagian 21 p21, , stepstp
Scala scala
Skema scheme
Scilab scilab, sci
Ekspresi Bentuk shexc
Shell shell, console
Smali smali
Smalltalk smalltalk, st
Solidity solidity, sol
Stan stan
Stata stata
Teks Terstruktur iecst, , sclstl,structured-text
Stylus stylus, styl
SubUnit subunit
Supercollider supercollider, sc
Swift swift
Tcl tcl, tk
Terraform (HCL) terraform, , tfhcl
Menguji Protokol Apa Pun tap
Tex tex
Thrift thrift
TOML toml
Tiga Tiang tp
Ranting twig, craftcms
TypeScript typescript, ts
VB.NET vbnet, vb
VBScript vbscript, vbs
VHDL vhdl
Vala vala
Verilog verilog, v
Skrip Vim vim
Visual Basic vb
Visual Basic untuk Aplikasi vba
X++ xpp
Rakitan x86 x86asm
XL xl, tao
XQuery xquery, , xpathxq
XAML xaml
XML xml, , rssxhtml, atom, xjb, xsd, , xsl,plist
YAML yml, yaml
Zephir zephir, zep

Tip

Fitur Learn Authoring Pack, Dev Lang Completion menggunakan alias valid pertama saat beberapa alias tersedia.

Langkah berikutnya

Untuk informasi tentang pemformatan teks untuk tipe konten selain kode, lihat Panduan pemformatan teks.