Kód belefoglalása a dokumentációba

A Microsoft Learnben közzétett cikkben szereplő kódokat a képernyőképeken kívül többféleképpen is fel lehet venni:

• Különálló elemek (szavak) egy sorban.

  Például a code stílusára.

  A szövegben található közeli kódblokkban használja a kódformátumot, amikor nevesített paraméterekre hivatkozik. A kódformátum tulajdonságokhoz, metódusokhoz, osztályokhoz és nyelvi kulcsszavakhoz is használható. További információt a cikk későbbi, Kódegységek című részében találhat.

• Kódblokkok a cikk Markdown-fájljában.

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

  Ha nem praktikus egy kódot egy fájlhivatkozással megjeleníteni, használjon beágyazott kódblokkokat. További információt a cikk későbbi, Kódblokkok című részében találhat.

• Kódblokkok a helyi adattárban lévő kódfájlra mutató hivatkozással.

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

  További információt a cikk későbbi, Hivatkozás adattárban lévő kódrészletekre című részében találhat.

• Kódblokkok másik adattárban lévő kódfájlra mutató hivatkozással.

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

  További információt a cikk későbbi, Hivatkozás adattáron kívüli kódrészletekre című részében találhat.

• Kódblokkok, amelyek lehetővé teszik a felhasználó számára kód végrehajtását a böngészőben.

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

  További információt a cikk későbbi, Interaktív kódtöredékek című részében találhat.

A cikk azonkívül, hogy elmagyarázza a Markdown kódot a kódok belefoglalásának összes módjához, az összes kódblokkhoz is tartalmaz általános útmutatót.

Kódelemek

Kódelem (code element) a programnyelv kulcsszava, osztályneve, tulajdonságneve stb. Nincs mindig nyilvánvaló mi minősül kódnak. Például a NuGet-csomagneveket kódként kell kezelni. Ha kétségei vannak, olvassa el a Szövegformázási útmutatót.

Beágyazott kódstílus

Ha egy kódelemet szeretne belefoglalni a cikk szövegében, akkor a kódstílus jelzéséhez használjon háttérjeleket ('). A beágyazott kódstílus nem használhat háromszoros ` karakteres formátumot.

Markdown	Megjelenítve
Az Entity Framework alapértelmezés szerint elsődleges kulcsként egy "Id" vagy "ClassnameID" nevű tulajdonságot értelmez.	Alapértelmezés szerint az Entity Framework az Id vagy a ClassnameID nevű tulajdonságot elsődleges kulcsként értelmezi.

Amikor egy cikket honosítanak (más nyelvekre fordítanak le), a kódstílusként megjelölt szöveget nem fordítják le. Ha a kód stílusa nélkül szeretné megakadályozni a honosítást, tekintse meg a Nem honosított sztringek című szakaszt.

Félkövér stílus

Néhány régi stílusútmutató a félkövér stílust határozza meg a beágyazott kódhoz. A félkövér akkor választható, ha a kódstílus annyira zavaró, hogy csökkenti az olvashatóságot. Egy többnyire kódrészleteket tartalmazó Markdown-táblázat például túlzsúfoltnak tűnhet, ha mindenütt kódstílust alkalmaz benne. Ha félkövér stílust szeretne használni, nem honosított sztringszintaxissal gondoskodhat róla, hogy a kód nincs honosítva.

Links

Egy referenciadokumentációra mutató link hasznosabb lehet bizonyos esetekben, mint a kódformátum. Ha linket használ, ne alkalmazzon kódformátumot a link szövegére. Ha egy hivatkozást kódstílussal jelöl, az megnehezítheti a szöveg hivatkozásként való értelmezését.

Ha egy linkkel később azonos kontextusban azonos elemre hivatkozik, a további példányokat linkek helyett kódformátumként adja meg. Például:

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

Megjelenítve:

A szöveg első hivatkozása System.CommandLine egy hivatkozás. A későbbi hivatkozások System.CommandLine kódstílusban is lehetnek.

Helyőrzők

Ha azt szeretné, hogy a felhasználó lecserélje a megjelenített kód egy szakaszát a saját értékeire, használjon szögletes zárójelekkel jelölt helyőrző szöveget. Például:

az group delete -n <ResourceGroupName>

Előfordulhat, hogy a szögletes zárójeleket el kell távolítani valós értékek helyettesítésekor. A Microsoft írásstílus-útmutatója dőlt betűs formázást kér, amelyet szögletes zárójeles beágyazott kódon belül formázhat:

<ResourceGroupName> az az erőforráscsoport, ahol...

A kapcsos zárójelek { } nem használhatók szintaktikai helyőrzőkként. Összetéveszthetők ugyanazzal a jelöléssel, amelyet a helyettesíthető szövegben, a sztringek formázásában, a sztring interpolációjában, a szövegsablonokban és a hasonló programozási szerkezetekben használnak.

A helyőrző nevek elválaszthatók kötőjelekkel ("kebab-eset"), aláhúzásjelekkel, vagy egyáltalán nem elválaszthatók (Pascal-eset). A Kebab-eset szintaxishibákat okozhat, és az aláhúzások ütközhetnek az aláhúzással. Az all-caps számos nyelven ütközhet az elnevezett állandókkal, de felhívhatja a figyelmet a helyőrző nevére is.

<Resource-Group-Name> vagy <ResourceGroupName>

Kódblokkok

Egy dokumentumba kódot foglaló szintaxis a kód helyétől függ:

• A cikk Markdown-fájljában
• Az azonos adattárban lévő kódfájlban
• Más adattárban lévő kódfájlban

Az alábbiakban olyan irányelvek következnek, amelyek a kódblokkok mind a három típusára vonatkoznak:

• Screenshotok
• Kódérvényesítés automatizálása
• Kódsorok kiemelése
• Vízszintes görgetősávok elkerülése
• A hibás kód egyértelmű azonosítása

Screenshots

Az előző szakaszban felsorolt metódusok használható kódblokkokat eredményeznek:

• Ezeket kimásolhatja és beillesztheti.
• A keresőmotorok indexelik őket.
• Elérhetők a képernyőolvasók számára.

Ez csupán néhány ok arra, hogy miért nem javasolt IDE-képernyőképeket használni kód egy cikkbe történő belefoglalásához. Csak akkor használjon IDE-képernyőképeket a kódhoz, ha magáról az IDE-ről szeretne megjeleníteni valamit, például az IntelliSense esetében. Ne használjon képernyőképeket kizárólag a színezés és kiemelések bemutatására.

Kódellenőrzés

Néhány adattár már megvalósított olyan folyamatokat, amelyek hibaellenőrzés céljából automatikusan lefordítanak minden mintakódot. Ez a .NET-adattár feladata. További információ: Contributing (Hozzájárulás) a .NET-adattárban.

Ha más adattárból származó kódblokkokat is használ, dolgozzon ki a tulajdonosokkal közösen egy karbantartási stratégiát a kódhoz, hogy a használt kód ne hibásodjon meg vagy évüljön el a kód által használt könyvtárak új verzióinak megjelenésével.

Kiemelés

A kódrészletek általában a szükségesnél több kódot tartalmaznak a kontextus biztosításához. Segít az olvashatóság növelésében, ha kiemeli azokat a kulcsfontosságú sorokat, amelyekre a kódrészletben koncentrál, ahogyan az ebben a példában látható:

Nem lehet kiemelni a kódot, ha belefoglalja a cikk Markdown-fájljába. Ez csak a kódfájlra mutató hivatkozásként belefoglalt kódrészleteknél működik.

Vízszintes görgetősávok

A hosszú sorok tördelésével kerülje el a vízszintes görgetősávok megjelenítését. A kódblokkok görgetősávjai nehezen olvashatóvá teszik a kódot. Ez hosszú kódblokkok esetén különösen problémás, mert előfordulhat, hogy nem látható egyszerre a görgetősáv és az olvasni kívánt sor is.

Bevált gyakorlat a kódblokk vízszintes görgetősávjai számának minimálisra csökkentése érdekében a 85 karakternél hosszabb kódsorok tördelése. Ne feledje azonban, hogy a görgetősáv jelenléte vagy hiánya nem az olvashatóság egyetlen feltétele. Ha a 85 karakternél hamarabb történő sortörés befolyásolja az olvashatóságot vagy a másolás és beillesztés könnyűségét, menjen nyugodtan 85 fölé.

A hibás kód egyértelmű azonosítása

Bizonyos helyzetekben hasznos, ha olyan kódolási mintákat mutatunk be, amelyeket el kell kerülni, például:

• Olyan kód, amely fordítási hibát fog okozni, ha megpróbálják.
• Helyesen lefordított, de nem ajánlott kód.

Az alábbi forgatókönyvek esetében:

• A hiba magyarázata a kód megjegyzéseiben és a cikk szövegében is.

  Az olvasók gyakran kihagyják a cikk szövegét, és csak a kódot nézik, így nem elég csak a cikk szövegében magyarázni a hibát. A hibát nem elég csak a kód megjegyzéseiben magyarázni, mert a kódmegjegyzések nincsenek honosítva.

• Érdemes megjegyzést fűzni a kódhoz, ha fordítási hibát okozna.

  A megjegyzésként megadott kód nem fogja megzavarni a folyamatos integrációs (CI) rendszert, ha a cikk adattára rendelkezik most vagy implementál egyet a jövőben.

A nem ajánlott kód bemutatására a Rune használati példájában talál példát: betűs kis- és nagybetűk módosítása. Ebben a példában az a tanács, hogy elkerüljük, még a kódba is bele van építve, mivel a C# metódus neve .ConvertToUpperBadExample

Beágyazott kódblokkok

Csak akkor használjon beágyazott kódblokkokat, ha nem praktikus egy kódot egy fájlhivatkozással megjeleníteni. A beágyazott kód általában nehezebben tesztelhető és tartható naprakészen, mint egy teljes projekthez tartozó kódfájl. A beágyazott kód pedig kihagyhat olyan kontextuselemeket, amelyek segíthetnek a fejlesztőnek megérteni és használni a kódot. Ezek a megfontolások főleg a programozási nyelvekre vonatkoznak. A beágyazott kódblokkok emellett ki- és bemenetekhez (például JSON-fájlokhoz), lekérdezési nyelvekhez (például SQL) és szkriptelési nyelvekhez (például PowerShell) is használhatók.

Egy cikkfájl szövegszakaszának jelzésére kétféleképpen lehet kódblokkot megadni: a szövegrészeket három hátoldalon ('' ) vagy behúzással lehet megkötni. Az elkerítés használata ajánlott, mert lehetővé teszi a kódnyelv meghatározását. Kerülje a behúzás használatát, mert túl könnyen elrontható, és egy másik írónak nehezére eshet megértenie az Ön szándékát a cikk szerkesztésekor.

A kódnyelv jelzése közvetlenül a nyitó három fordított aposztróf után következik, amint a következő példában látható:

Markdown:

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

Megjelenítve:

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

A kódnyelv jelzésére használható értékekről további információért lásd: Language names and aliases (Kódnyelvek neve és aliasai).

Ha olyan nyelvet vagy környezeti szót használ, amely nem támogatott a tripla-backticks (') után, az a szó megjelenik a kódszakasz címsorában a renderelt oldalon. Amikor teheti, használjon nyelvi vagy környezeti indikátort a beágyazott kódblokkokban.

Hivatkozás adattárban lévő kódrészletekre

A programnyelvek kódrészleteinek dokumentumokba foglalásának előnyben részesített módja kódfájlra való hivatkozással történik. Ezzel a módszerrel kiemelhet kódsorokat, és elérhetővé teheti a kódrészlet szélesebb kontextusát a GitHubon a fejlesztők számára. A kódot három kettőspont formátummal (:::) manuálisan vagy a Visual Studio Code-ban a Learn Authoring Pack segítségével is felveheti.

1. A Visual Studio Code-ban nyomja le az ALT + M vagy az Option + M billentyűkombinációt, és válassza a Kódrészlet elemet.
2. Miután kiválasztotta a kódrészletet, választania kell a Teljes keresés, a Hatókörön belüli keresés és a Több adattáras referencia közül. Ha helyileg szeretne keresni, válassza a Teljes keresést.
3. A fájl megkereséséhez adja meg a keresett kifejezést. Ha megtalálta a fájlt, jelölje ki.
4. Ezután határozza meg a lehetőségek kiválasztásával, hogy a kódrészlet a kód mely sorát tartalmazza. A beállítások a következők: AZONOSÍTÓ, Tartomány és Nincs.
5. A 4. lépésben kiválasztott lehetőségtől függően adjon meg egy értéket, ha szükséges.

A teljes kódfájl megjelenítése:

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

A kódfájl egy részének megjelenítése a sorok számának megadásával:

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

A kódfájl egy részének megjelenítése a kódrészlet nevének megadásával:

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

Ezeket a példákat az alábbi szakaszok ismertetik:

• Relatív elérési út használata a kódfájlhoz
• Csak a kijelölt sorok számának belefoglalása
• Hivatkozás elnevezett kódrészletre
• Kijelölt sorok kiemelése

További információt a cikk későbbi, A kódrészlet szintaxisának referenciája című részében találhat.

Kódfájl elérési útja

Példa:

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

A példa az ASP.NET-dokumentumtár, aspnetcore/data/ef-mvc/crud.md cikkének fájljából származik. A kódfájlra egy relatív elérési út hivatkozik: aspnetcore/data/ef-mvc/intro/samples/cu/Controllers/StudentsController.cs ugyanabban az adattárban.

Kijelölt sorok száma

Példa:

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

Ez a példa a StudentController.cs fájlnak csak a 2-24. és 26. sorát jeleníti meg.

Nevesített kódrészletek előnyben részesítése a nem módosítható sorszámokkal szemben, amint azt a következő szakaszban ismertetjük.

Elnevezett kódrészletek

Példa:

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

A névben csak betűket és aláhúzást használjon.

A példában a kódfájl snippet_Create szakasza látható. A példában szereplő kódfájl kódrészletei a C#-kód megjegyzéseiben tartalmaznak címkéket:

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

Az elnevezett kódrészletek beágyazhatók az alábbi példában látható módon:

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

Method A kódrészlet megjelenítésekor a Line címkék nem szerepelnek a renderelt kimenetben.

Amikor csak lehet hivatkozzon elnevezett szakaszokra a sorszámok megadása helyett. A sorszámokra való hivatkozás nem elég rugalmas, mert a kódfájlok elkerülhetetlenül módosulnak, ezért a sorszámok is változnak. Ezekről a változásokról nem feltétlenül kap értesítést. A cikkben végül nem a megfelelő sorok fognak megjelenni, és Ön nem fog tudni róla, hogy valami megváltozott.

Kijelölt sorok kiemelése

Példa:

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

A példában a megjelenített kódrészlet elejétől kezdődően a 2. és az 5. sor lesz kiemelve. A kiemelendő sorszámok számítása nem a kódfájl elejétől kezdődik. Más szóval a kódfájl 3. és 6. sora lesz kiemelve.

Hivatkozás adattáron kívüli kódrészletekre

Ha a kódfájl, amelyre hivatkozni szeretne, egy másik adattárban található, akkor függő adattárként kell beállítania a kódtárat. Ennek végrehajtásakor meg kell határoznia a nevét. Ez a név mappanévként fog viselkedni a kódhivatkozások megadásakor.

A dokumentumtár például Azure/azure-docs, a kódtár pedig Azure/azure-functions-durable-extension.

Az azure-docs gyökérmappájában vegye fel a következő szakaszt az .openpublishing.publish.config.json fájlban:

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

Amikor úgy hivatkozik a samples-durable-functions helyre, mintha az egy mappa volna az azure-docs helyen, akkor valójában az azure-functions-durable-extension adattár gyökérmappájára hivatkozik.

A kódot három kettőspont formátummal (:::) manuálisan vagy a Visual Studio Code-ban a Learn Authoring Pack segítségével is felveheti.

1. A Visual Studio Code-ban nyomja le az ALT + M vagy az Option + M billentyűkombinációt, és válassza a Kódrészlet elemet.
2. Miután kiválasztotta a kódrészletet, választania kell a Teljes keresés, a Hatókörön belüli keresés és a Több adattáras referencia közül. Ha több adattárban szeretne keresni, válassza a Több adattáras referenciát.
3. Az .openpublishing.publish.config.json-ban lévő adatárak közül választhat. Válasszon ki egy adattárat.
4. A fájl megkereséséhez adja meg a keresett kifejezést. Ha megtalálta a fájlt, jelölje ki.
5. Ezután határozza meg a lehetőségek kiválasztásával, hogy a kódrészlet a kód mely sorát tartalmazza. A beállítások a következők: AZONOSÍTÓ, Tartomány és Nincs.
6. Az 5. lépésben kiválasztott lehetőségtől függően adjon meg egy értéket.

A kódrészlet-hivatkozás a következőképpen fog kinézni:

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

Az azure-functions-durable-extension adattárban ez a kódfájl a samples/csx/shared mappában található. Ahogyan korábban említettük, a kiemelés sorszámai a kódrészlet elejéhez vannak viszonyítva, és nem a fájl elejéhez.

Kódrészletek Jupyter-jegyzetfüzetben

Egy Jupyter-jegyzetfüzet egy cellájára kódrészletként hivatkozhat. A cellára való hivatkozáshoz:

1. Cella metaadatainak hozzáadása a jegyzetfüzethez a hivatkozni kívánt cellákhoz.
2. Az adattárhoz való hozzáférés beállítása.
3. Használja a Jupyter-jegyzetfüzet kódrészletének szintaxisát a markdown-fájlban.

Metaadatok hozzáadása jegyzetfüzethez

1. Nevezze el a cellát úgy, hogy hozzáadja a cella metaadatait a Jupyter-jegyzetfüzethez.

   • A Jupyterben a cella metaadatainak szerkesztéséhez először engedélyeznie kell a cella eszköztárát: Cella eszköztárának > megtekintése > Metaadatok szerkesztése.
   • Ha a cella eszköztára engedélyezve van, válassza a Metaadatok szerkesztése lehetőséget azon a cellán, amelyet el szeretne nevezni.
   • A metaadatokat közvetlenül a jegyzetfüzet JSON-struktúrájában is szerkesztheti.

2. A cella metaadataiban adjon hozzá egy "name" attribútumot:

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

   Például:

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

   Tipp.

   Bármilyen más metaadatot hozzáadhat, amely segít nyomon követni a cella használatának helyét. Például:

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

Adattár-hozzáférés beállítása

Ha a hivatkozni kívánt jegyzetfüzetfájl egy másik adattárban található, állítsa be a kódtárat függő adattárként.

Jupyter notebook-kódrészlet szintaxisának referenciája

Miután a jegyzetfüzet tartalmazza a szükséges metaadatokat, hivatkozzon rá a Markdown-fájlban. Használja a <cell-name-value> jegyzetfüzethez hozzáadott és a <path> függő adattárként beállított tárházat.

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

Például:

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

Használja a támogatott nyelvek bármelyikét az <language> azonosítóhoz.

Interaktív kódtöredékek

Beágyazott interaktív kódblokkok

A következő kódnyelvek esetén a kódrészletek végrehajthatóvá tehetők a böngészőablakban:

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

Ha engedélyezve van az interaktív mód, a megjelenített kódmezők Kipróbálás vagy Futtatás gombbal fognak rendelkezni. Például:

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

a következőképp jelenik meg:

New-AzResourceGroup -Name myResourceGroup -Location westeurope

And

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

a következő módon jelenik meg:

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

A funkció egy adott kódblokkra vonatkozóan egy speciális nyelvi azonosítóval élesíthető. Az elérhető lehetőségek:

• azurepowershell-interactive – Elérhetővé válik az Azure PowerShell Cloud Shell, mint az előző példában
• azurecli-interactive – Elérhetővé válik az Azure Cloud Shell
• csharp-interactive – Elérhetővé válik a C# REPL

Az Azure Cloud Shell és a PowerShell Cloud Shell esetén a felhasználók csak a saját Azure-fiókjukban hajthatnak végre parancsokat.

Hivatkozással megadott kódrészletek

A hivatkozásként megadott kódrészletekhez engedélyezheti az interaktív módot. Ha ezt a funkciót egy adott kódblokkra szeretné bekapcsolni, használja az interactive attribútumot. Az attribútum lehetséges értékei a következők:

• cloudshell-powershell – Elérhetővé válik az Azure PowerShell Cloud Shell, mint az előző példában
• cloudshell-bash – Elérhetővé válik az Azure Cloud Shell
• try-dotnet – Lehetővé teszi a Try .NET használatát
• try-dotnet-class – Lehetővé teszi a Try .NET használatát osztályok állványzatával (scaffolding)
• try-dotnet-method – Lehetővé teszi a Try .NET használatát metódusok állványzatával (scaffolding)

Íme néhány példa:

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

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

Az Azure Cloud Shell és a PowerShell Cloud Shell esetén a felhasználók csak a saját Azure-fiókjukban hajthatnak végre parancsokat.

Az interaktív .NET használatához a kódblokk tartalma attól függ, hogy a három állványzattípus közül melyiket választja:

• Nincs állványzat (try-dotnet): A kódblokknak teljes programszöveget kell jelölnie. A dotnet new console által létrehozott Program.cs fájl például érvényes lesz. Ez a leghasznosabb kis méretű teljes program megjelenítéséhez, beleértve a szükséges using direktívát is. A felső szintű utasítások jelenleg nincsenek támogatva.
• Metódusok állványzata (try-dotnet-method): A kódblokknak egy konzolalkalmazásban lévő metódus tartalmát Main kell jelölnie. A using direktívák hozzáadása a dotnet new console sablonnal oldható meg. Ez a beállítás a legmegfelelőbb a kisebb kódrészletekhez, amelyek egy funkciót mutatnak be.
• Osztályállványok (try-dotnet-class): A kódblokknak egy metódussal rendelkező Main osztályt kell jelölnie a program belépési pontjaként. Ezzel megjeleníthető az, hogy hogyan kommunikálnak egymással egy osztály tagjai.

A kódrészlet szintaxisának referenciája

Szintaxis:

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

• <language> (választható)

  • A kódtöredék nyelve. További információkért tekintse meg a cikk későbbi, Támogatott nyelvek című szakaszát.

• <path> (kötelező)

  • Relatív elérési út a fájlrendszerben, amely a hivatkozandó kódtöredék-fájlra mutat.

• <attribute> és <attribute-value> (választható)

  • A kód fájlból való lekérésének és megjelenítésének együttes meghatározására szolgál:
    • range: 1,3-5 Sorokból álló tartomány. Ebben a példában az 1., a 3., a 4. és az 5. sor szerepel.
    • id: Create A kódfájlból beszúrni kívánt kódrészlet azonosítója. Ez az érték nem létezhet együtt a tartománnyal.
    • highlight: 2-4,6 A létrehozott kódrészletben kiemelendő sorok tartománya és/vagy száma. A számozás a (tartomány vagy az azonosító által megadott,) megjelenített sorokhoz viszonyul, nem a fájlhoz.
    • Az interactive: cloudshell-powershell, cloudshell-bash, try-dotnet, try-dotnet-class, try-dotnet-method sztringérték határozza meg, hogy milyen típusú interaktivitás lesz engedélyezve.
    • További információt a kódtöredékek forrásfájljaiban szereplő címkenevek nyelv szerinti megjelenéséről a DocFX-irányelvek című leírásban talál.

Támogatott nyelvek

A Learn Authoring Pack tartalmaz egy funkciót, amely biztosítja a kódkerítési blokkok elérhető nyelvi azonosítóinak kiegészítését és érvényesítését.

Elkerített kódblokkok

Név	Érvényes aliasok
.NET Core CLI	dotnetcli
1C	1c
ABNF	abnf
Hozzáférési naplók	accesslog
Ada	ada
ARM assembler	armasm, arm
AVR assembler	avrasm
ActionScript	actionscript, as
Alan	alan, i
AngelScript	angelscript, asc
ANTLR	antlr
Apache	apache, apacheconf
AppleScript	applescript, osascript
Arcade	arcade
AsciiDoc	asciidoc, adoc
AspectJ	aspectj
ASPX	aspx
ASP.NET (C#)	aspx-csharp
ASP.NET (VB)	aspx-vb
AutoHotkey	autohotkey
AutoIt	autoit
Awk	awk, mawk, nawkgawk
Axapta	axapta
AzCopy	azcopy
Azure CLI	azurecli
Azure CLI (interaktív)	azurecli-interactive
Azure PowerShell	azurepowershell
Azure Powershell (interaktív)	azurepowershell-interactive
Bash	bash, , shzsh
Basic	basic
BNF	bnf
K	c
C#	csharp, cs
C# (interaktív)	csharp-interactive
C++	cpp, c, cc, hc++, h++hpp
C++/CX	cppcx
C++/WinRT	cppwinrt
C/AL	cal
Gyorsítótár-objektum szkriptje	cos, cls
CMake	cmake, cmake.in
Coq	coq
CSP	csp
CSS	css
Cap'n Proto	capnproto, capnp
Clojure	clojure, clj
CoffeeScript	coffeescript, coffee, csoniced
Crmsh	crmsh, , crmpcmk
Crystal	crystal, cr
Cypher (Neo4j)	cypher
D	d
DAX Power BI	dax
DNS-zónafájl	dns, , zonebind
DOS	dos, , batcmd
Dart	dart
Delphi	delphi, dpr, dfm, paspascal, freepascal, lazarus, , lprlfm
Diff	diff, patch
Django	django, jinja
Dockerfile	dockerfile, docker
dsconfig	dsconfig
DTS (eszközfa)	dts
Dust	dust, dst
Dylan	dylan
EBNF	ebnf
Elixir	elixir
Elm	elm
Erlang	erlang, erl
Excel	excel, , xlsxlsx
Extempore	extempore, , xtlangxtm
F#	fsharp, fs
FIX	fix
Fortran	fortran, , f90f95
G-Code	gcode, nc
Gams	gams, gms
GAUSS	gauss, gss
GDScript	godot, gdscript
Gherkin	gherkin
GN for Ninja	gn, gni
Go	go, golang
Golo	golo, gololang
Gradle	gradle
GraphQL	graphql
Groovy	groovy
HTML	html, xhtml
HTTP	http, https
Haml	haml
Kormányok	handlebars, hbs, html.hbshtml.handlebars
Haskell	haskell, hs
Haxe	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
Levél	leaf
Lasso	lasso, , lslassoscript
Összecsukás	less
LDIF	ldif
Lisp	lisp
LiveCode Server	livecodeserver
LiveScript	livescript, ls
Lua	lua
Makefile	makefile, , mkmak
Markdown	markdown, md, mkdownmkd
Mathematica	mathematica, , mmawl
Matlab	matlab
Maxima	maxima
Maya Embedded Language	mel
Mercury	mercury
mIRC parancsprogramnyelv	mirc, mrc
Mizar	mizar
Managed Object Format	mof
Mojolicious	mojolicious
Monkey	monkey
Moonscript	moonscript, moon
MS Graph (interaktív)	msgraph-interactive
N1QL	n1ql
NSIS	nsis
Nginx	nginx, nginxconf
Nimrod	nimrod, nim
Nix	nix
OCaml	ocaml, ml
Objective C	objectivec, mm, objcobj-c
OpenGL Shading Language	glsl
OpenSCAD	openscad, scad
Oracle Rules Language	ruleslanguage
Oxygene	oxygene
PF	pf, pf.conf
PHP	php, php3, php4, php5php6
Parser3	parser3
Perl	perl, , plpm
Egyszerű szöveg, kiemelés nélkül	plaintext
Pony	pony
PostgreSQL & PL/pgSQL	pgsql, , postgrespostgresql
PowerShell	powershell, ps
PowerShell (interaktív)	powershell-interactive
Feldolgozás	processing
Prolog	prolog
Tulajdonságok	properties
Protokollpufferek	protobuf
Puppet	puppet, pp
Python	python, , pygyp
A Python Profiler eredményei	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
Robot Framework	robot, rf
RPM-specifikációs fájlok	rpm-specfile, rpm, spec, rpm-specspecfile
Ruby	ruby, rb, gemspec, podspecthorirb
Rust	rust, rs
SAS	SAS, sas
SCSS	scss
SQL	sql
STEP Part 21	p21, , stepstp
Scala	scala
Séma	scheme
Scilab	scilab, sci
Alak kifejezések	shexc
Felület	shell, console
Smali	smali
Smalltalk	smalltalk, st
Solidity	solidity, sol
Stan	stan
Stata	stata
Strukturált szöveg	iecst, scl, stlstructured-text
Stylus	stylus, styl
SubUnit	subunit
SuperCollider	supercollider, sc
Swift	swift
Tcl	tcl, tk
Terraform (HCL)	terraform, , tfhcl
Test Anything Protocol	tap
TeX	tex
Thrift	thrift
TOML	toml
TP	tp
Twig	twig, craftcms
TypeScript	typescript, ts
VB.NET	vbnet, vb
VBScript	vbscript, vbs
VHDL	vhdl
Vala	vala
Verilog	verilog, v
Vim Script	vim
Visual Basic	vb
Visual Basic for Applications	vba
X++	xpp
x86 Assembly	x86asm
XL	xl, tao
xQuery	xquery, , xpathxq
XAML	xaml
XML	xml, xhtml, rss, atomxjb, xsd, xslplist
YAML	yml, yaml
Zephir	zephir, zep

További lépések

További információ a nem kód típusú tartalmak szövegformázásához: Szövegformázási útmutató.