Sådan medtager du kode i dokumentationen

Der er flere andre måder end skærmbilleder at inkludere kode i en artikel, der er publiceret på Microsoft Learn:

• Enkelte elementer (ord) i en linje.

  Her er et eksempel på typografien code.

  Brug kodeformat, når du refererer til navngivne parametre og variabler i en kodeblok i nærheden i din tekst. Kodeformatet kan også bruges til egenskaber, metoder, klasser og nøgleord til computersprog. Du kan finde flere oplysninger under Kodeelementer senere i denne artikel.

• Kodeblokke i Markdown-artikelfilen.

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

  Brug indbyggede kodeblokke, når det er upraktisk at vise kode ved at referere til en kodefil. Du kan finde flere oplysninger under Kodeblokke senere i denne artikel.

• Kodeblokke ved at referere til en kodefil i det lokale lager.

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

  Du kan finde flere oplysninger under Referencer til kodestykker i lageret senere i denne artikel.

• Kodeblokke ved at referere til en kodefil i et andet lager.

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

  Du kan finde flere oplysninger under Referencer til kodestykker uden for lageret senere i denne artikel.

• Kodeblokke, der giver brugeren mulighed for at udføre kode i browseren.

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

  Du kan finde flere oplysninger under Interaktive kodestykker senere i denne artikel.

Ud over at forklare Markdown for hver af disse måder at inkludere kode på, indeholder artiklen nogle generelle retningslinjer for alle kodeblokke.

Kodeelementer

Et "kodeelement" er et nøgleord til computersprog, klassenavn, egenskabsnavn osv. Det er ikke altid tydeligt, hvad der betegnes som kode. Navne på NuGet-pakker skal f.eks. behandles som kode. Når du er i tvivl, kan du se Retningslinjer til tekstformatering.

Indbygget kodetypografi

Hvis du vil medtage et kodeelement i artikelteksten, skal du omgive det med backticks (') for at angive kodetypografi. Formatet med tredobbelt accent grave bør ikke anvendes til indbygget kodetypografi.

Markdown	Gengives
Entity Framework fortolker som standard en egenskab med navnet 'Id' eller 'ClassnameID' som den primære nøgle.	Entity Framework fortolker som standard en egenskab med navnet Id eller ClassnameID som den primære nøgle.

Når en artikel lokaliseres (oversat til andre sprog), bliver tekst, der angives som kode, ikke oversat. Hvis du vil forhindre lokalisering uden at bruge kodetypografi, skal du se Ikke-lokaliserede strenge.

Typografien Fed

Nogle af de ældre stilvejledninger angiver fed for indbygget kode. Fed er en mulighed, når kodetypografien er så pågående, at den kompromitterer læsevenligheden. En Markdown-tabel, der primært indeholder kodeelementer, kan f.eks. se rodet ud med kodetypografi overalt. Hvis du vælger at bruge fed typografi, skal du bruge syntaksen for ikke-lokaliserede strenge for at sikre, at koden ikke lokaliseres.

Link

Et link til referencedokumentation kan være mere nyttigt end kodeformatet i nogle kontekster. Hvis du bruger et link, skal du ikke anvende kodeformat på linkteksten. Hvis man skriver et link som kode, kan man risikere at skjule det faktum, at teksten er et link.

Hvis du bruger et link og refererer til det samme element senere i den samme kontekst, er det en god idé at angive de efterfølgende forekomster i kodeformat i stedet for links. Eksempler:

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

Gengives:

Den første reference til System.CommandLine i denne tekst er et link. Efterfølgende referencer til System.CommandLine kan være i kodetypografi.

Pladsholdere

Hvis brugeren skal erstatte en del af den viste kode med sine egne værdier, skal du bruge pladsholdertekst, der er markeret med vinkelparenteser. Eksempler:

az group delete -n <ResourceGroupName>

Du kan bemærke, at kantede parenteser skal fjernes, når de reelle værdier erstattes. Microsoft Writing Style Guide kalder kursiv, som du kan formatere i vinkelparenteser med indbygget kode:

<ResourceGroupName> er den ressourcegruppe, hvor...

Krøllede klammeparenteser { } frarådes til brug som syntaktiske pladsholdere. De kan forveksles med den samme notation, der bruges i udskiftelig tekst, formatstrenge, strenginterpolering, tekstskabeloner og lignende programmeringskonstruktioner.

Pladsholdernavne kan adskilles med bindestreger ("kebab"), med understregningstegn eller slet ikke adskilt (Pascal-store og små bogstaver). Kebab-tilfælde kan generere syntaksfejl, og understregningstegn kan være i konflikt med understregning. Store bogstaver kan være i konflikt med navngivne konstanter på mange sprog, selvom det også kan henlede opmærksomheden på pladsholdernavnet.

<Resource-Group-Name> eller <ResourceGroupName>

Kodeblokke

Syntaksen for inkludering af kode i et dokument afhænger af, hvor koden er placeret:

• I Markdown-artikelfilen
• I en kodefil i det samme lager
• I en kodefil i et andet lager

Følgende er retningslinjer, der gælder for alle tre typer kodeblokke:

• Screenshots
• Automatiser kodevalidering
• Fremhæv kodelinjer
• Undgå vandrette rullepaneler
• Identificer tydeligt forkert kode

Skærmbilleder

Alle de metoder, der er angivet i det foregående afsnit, resulterer i brugbare kodeblokke:

• Du kan kopiere og indsætte fra dem.
• De er indekseret af søgemaskiner.
• De er tilgængelige for skærmlæsere.

Dette er blot nogle af årsagerne til, at IDE-skærmbilleder ikke anbefales som en metode til at inkludere kode i en artikel. Brug kun IDE-skærmbilleder til kode, hvis du viser noget om selve IDE-enheden, f.eks. IntelliSense. Brug ikke skærmbilleder til kun at vise farvelægning og fremhævning.

Kodevalidering

Nogle lagre har implementeret processer, der automatisk kompilerer al eksempelkode for at kontrollere, om der er fejl. .NET-lageret gør dette. Du kan finde flere oplysninger under Bidrag i .NET-lageret.

Hvis du inkluderer kodeblokke fra et andet lager, skal du samarbejde med ejerne om en vedligeholdelsesstrategi for koden, så din inkluderede kode ikke afbrydes eller forældes, efterhånden som nye versioner af de biblioteker, koden bruger, leveres.

Fremhævning

Kodestykker indeholder typisk mere kode, end det er nødvendigt for at kunne levere kontekst. Det hjælper på læsevenligheden, hvis du fremhæver vigtige linjer, som du fokuserer på i kodestykket, som i dette eksempel:

Du kan ikke fremhæve kode, når du inkluderer den i Markdown-artikelfilen. Det fungerer kun for kodestykker, der inkluderes som reference til en kodefil.

Vandrette rullepaneler

Opdel lange linjer for at undgå vandrette rullepaneler. Rullepaneler i kodeblokke gør det svært at læse koden. De er særligt problematiske i længere kodeblokke, hvor det kan være umuligt at se rullepanelet og den linje, du vil læse, samtidigt.

En god praksis for minimering af vandrette rullepaneler i kodeblokke er at opdele kodelinjer, der er længere end 85 tegn. Men husk på, at tilstedeværelsen eller fraværet af et rullepanel ikke er det eneste kriterium for læsevenlighed. Hvis opdeling af en linje før 85 tegn skader læsevenligheden eller muligheden for at kopiere og indsætte, kan du opdele efter de 85 tegn.

Identificer tydeligt forkert kode

I nogle scenarier er det nyttigt at påpege kodemønstre, der bør undgås, f.eks.:

• Kode, der forårsager en kompileringsfejl, hvis det forsøges.
• Kode, der kompileres korrekt, men som ikke anbefales.

I disse scenarier:

• Forklar fejlen både i kodekommentarer og artikeltekst.

  Læserne springer ofte artikelteksten over og ser kun på kode, så det er ikke nok kun at forklare fejlen i artikelteksten. Det er heller ikke nok at forklare fejlen kun i kodekommentarer, fordi kodekommentarer ikke lokaliseres.

• Overvej at udkommentere koden, hvis det ville medføre en kompileringsfejl.

  Kode, der er oprettet kommentarer til, forstyrrer ikke det kontinuerlige integrationssystem (CI), hvis artiklens lager har et nu eller implementerer et i fremtiden.

Hvis du vil se et eksempel på, hvordan du præsenterer kode, der ikke anbefales, skal du se Eksempel på kørselsbrug: ændring af bogstavsbogstav. I dette eksempel er rådene til at undgå det endda indbygget i selve koden, da C#-metodens navn er ConvertToUpperBadExample.

Indbyggede kodeblokke

Brug kun indbyggede kodeblokke, når det er upraktisk at vise kode ved at referere til en kodefil. Indbygget kode er generelt sværere at teste og opdatere sammenlignet med en kodefil, der er en del af et komplet projekt. Og den indbyggede kode kan udelade kontekst, som ellers ville hjælpe udvikleren med at forstå og bruge koden. Disse overvejelser gælder primært for computersprog. Indbyggede kodeblokke kan også bruges til output og input (såsom JSON), forespørgselssprog (såsom SQL) og scriptsprog (såsom PowerShell).

Der er to måder at angive, at en tekstsektion i en artikelfil er en kodeblok: ved at indhegning i tredobbelt backticks (''') eller ved at indrykke den. Indhegning foretrækkes, da det giver dig mulighed for at angive computersproget. Undgå at bruge indrykning, da det er for nemt at gøre forkert, og det kan være svært for en anden forfatter at forstå din hensigt, når vedkommende skal redigere din artikel.

Indikatorer for computersprog placeres umiddelbart efter den tredobbelte startaccent grave, som i følgende eksempel:

Markdown:

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

Gengives:

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

Tip

GitHub Flavored Markdown understøtter afgrænsning af kodeblokke med felter (~) og med backticks ('). Det symbol, der bruges til at åbne og lukke kodeblokken, skal være konsistent inden for den samme kodeblok.

Du kan finde oplysninger om de værdier, du kan bruge som indikatorer for computersprog, i Navne og aliasser for computersprog.

Hvis du bruger et sprog- eller miljøord efter de tredobbelte backticks ('''), der ikke understøttes, vises dette ord på titellinjen i kodeafsnittet på den gengivne side. Når det er muligt, skal du bruge en indikator for computersprog eller miljø i dine indbyggede kodeblokke.

Bemærk

Hvis du kopierer og indsætter kode fra et Word-dokument, skal du sørge for, at der ikke er nogen "krøllede anførselstegn", som ikke er gyldige i kode. Hvis der er, skal du sørge for at ændre dem tilbage til normale anførselstegn (' og "). Alternativt kan du stole på erstatningsfunktionen Learn Authoring Pack med smarte anførselstegn.

Referencer til kodestykker i lageret

Den foretrukne måde at inkludere kodestykker til computersprog på i Docs er ved at referere til en kodefil. Denne metode giver dig mulighed for at fremhæve kodelinjer og gør den bredere kontekst for kodestykket tilgængeligt i GitHub, så udviklerne kan bruge det. Du kan inkludere kode ved hjælp af formatet med tredobbelt kolon (:::) enten manuelt eller i Visual Studio Code ved hjælp af Learn Authoring Pack.

1. I Visual Studio Code skal du klikke på Alt + M eller Option + M og vælge Kodestykke.
2. Når Modestykke er valgt, bliver du bedt om at angive Komplet søgning, Omfangssøgning eller Reference på tværs af lagre. Hvis du vil søge lokalt, skal du vælge Fuld søgning.
3. Angiv et søgeord for at finde filen. Når du har fundet filen, skal du vælge den.
4. Derefter skal du vælge en indstilling for at bestemme, hvilke kodelinjer der skal inkluderes i kodestykket. Indstillingerne er: ID, Område og Ingen.
5. Afhængigt af dit valg i trin 4 skal du evt. angive en værdi.

Vis hele kodefilen:

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

Vis en del af en kodefil ved at angive linjenumre:

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

Vis en del af en kodefil ved at angive et navn på kodestykket:

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

I følgende afsnit forklares disse eksempler:

• Brug en relativ sti til kodefilen
• Inkluder kun valgte linjenumre
• Referer til et navngivet kodestykke
• Fremhæv valgte linjer

Du kan finde flere oplysninger under Reference til kodestykker senere i denne artikel.

Sti til kodefile

Eksempel:

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

Eksemplet er fra artikelfilen i ASP.NET-dokumentlageret, aspnetcore/data/ef-mvc/crud.md. Der refereres til kodefilen ved hjælp af en relativ sti til aspnetcore/data/ef-mvc/intro/samples/cu/Controllers/StudentsController.cs i samme lager.

Valgte linjenumre

Eksempel:

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

I dette eksempel vises kun linjerne 2-24 og 26 for kodefilen StudentController.cs.

Foretræk navngivne kodestykker frem for hard-coded linjenumre, som forklaret i næste afsnit.

Navngivet kodestykke

Eksempel:

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

Brug kun bogstaver og understregningstegn i navnet.

I eksemplet vises afsnittet snippet_Create i kodefilen. Kodefilen til dette eksempel har tags for kodestykker i kommentarer i C#-koden:

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

Navngivne kodestykker kan indlejres som vist i følgende eksempel:

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

Method Når kodestykket gengives, medtages mærkerne Line ikke i det gengivne output.

Når det er muligt, skal du referere til et navngivet afsnit i stedet for at angive linjenumre. Referencer til linjenumre er skrøbelige, da kodefiler uundgåeligt ændres på måder, som gør, at linjenumrene ændres. Du bliver ikke nødvendigvis informeret om disse ændringer. Din artikel begynder på et tidspunkt at vise de forkerte linjer, og du har ingen idé om, at der er noget, der har ændret sig.

Fremhævning af udvalgte linjer

Eksempel:

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

I eksemplet fremhæves linjerne 2 og 5, regnet fra starten af det viste kodestykke. De linjenumre, der skal fremhæves, regnes ikke fra starten af kodefilen. Med andre ord fremhæves linje 3 og 6 i kodefilen.

Referencer til kodestykker uden for lageret

Hvis den kodefil, du vil referere til, er i et andet lager, skal du konfigurere kodelageret som et afhængigt lager. Når du gør det, angiver du et navn på det. Dette navn fungerer derefter som et mappenavn med henblik på kodereferencer.

Dokumentlageret er f.eks. Azure/azure-docs, og kodelageret er Azure/azure-functions-durable-extension.

I rodmappen af azure-docs skal du tilføje følgende afsnit i .openpublishing.publish.config.json:

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

Når du nu refererer til samples-durable-functions, som var det en mappe i azure-docs, refererer du faktisk til rodmappen i lageret azure-functions-durable-extension.

Du kan inkludere kode ved hjælp af formatet med tredobbelt kolon (:::) enten manuelt eller i Visual Studio Code ved hjælp af Learn Authoring Pack.

1. I Visual Studio Code skal du klikke på Alt + M eller Option + M og vælge Kodestykke.
2. Når Modestykke er valgt, bliver du bedt om at angive Komplet søgning, Omfangssøgning eller Reference på tværs af lagre. Hvis du vil søge på tværs af lagre, skal du vælge Reference på tværs af lagre.
3. Du får mulighed for at vælge lagre, der er indeholdt i .openpublishing.publish.config.json. Vælg et lager.
4. Angiv et søgeord for at finde filen. Når du har fundet filen, skal du vælge den.
5. Derefter skal du vælge en indstilling for at bestemme, hvilke kodelinjer der skal inkluderes i kodestykket. Indstillingerne er: ID, Område og Ingen.
6. Afhængigt af dit valg i trin 5 skal du angive en værdi.

Din kodestykkereference vil se sådan ud:

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

I lageret azure-functions-durable-extension er denne kodefil i mappen samples/csx/shared. Som tidligere nævnt, står linjenumre til fremhævning i forhold til starten af kodestykket i stedet for starten af filen.

Bemærk

Det navn, du tildeler til det afhængige lager, er i forhold til roden af hovedlageret, men feltet (~) refererer til roden af dokumentsættet. Roden af dokumentsættet bestemmes af build_source_folder i .openpublishing.publish.config.json. Stien til kodestykket i foregående eksempel fungerer i azure-docs repo, fordi build_source_folder refererer til roden af lageret (.). Hvis build_source_folder var articles, ville stien starte med ~/../samples-durable-functions i stedet for ~/samples-durable-functions.

Kodestykker i en Jupyter-notesbog

Du kan referere til en celle i en Jupyter-notesbog som et kodestykke. For at referere til cellen:

1. Føj cellemetadata til notesbogen for de celler, du vil referere til.
2. Konfigurer adgang til lageret.
3. Brug syntaksen for jupyternotesbogens kodestykke i markdown-filen.

Føj metadata til notesbogen

1. Navngiv cellen ved at tilføje cellemetadata i Jupyter-notesbogen.

   • I Jupyter kan du redigere cellemetadata ved først at aktivere celleværktøjslinjen: Vis > værktøjslinjen > Rediger metadata for celle.
   • Når celleværktøjslinjen er aktiveret, skal du vælge Rediger metadata i den celle, du vil navngive.
   • Du kan også redigere metadata direkte i notesbogens JSON-struktur.

2. I cellemetadata skal du tilføje attributten "name":

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

   Eksempler:

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

   Tip

   Du kan tilføje andre metadata, som du vil hjælpe dig med at spore, hvor cellen bruges. Eksempler:

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

Konfigurer lageradgang

Hvis den notesbogfil, du vil referere til, findes i et andet lager, skal du konfigurere kodelageret som et afhængigt lager.

Jupyter-syntaksreference til notesbogstykke

Når notesbogen indeholder de påkrævede metadata, skal du referere til den i din Markdown-fil. Brug den , <cell-name-value> du har føjet til notesbogen, og den <path> , du har konfigureret som dit afhængige lager.

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

Eksempler:

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

Vigtigt

Denne syntaks er en Markdown-udvidelse af en blok. Den skal bruges på en selvstændig linje.

Brug et af de understøttede sprog til id'et <language> .

Interaktive kodestykker

Indbyggede interaktive kodeblokke

Kodestykker kan gøres eksekverbare i browservinduet for følgende computersprog:

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

Når den interaktive tilstand aktiveres, har de gengivne kodefelter enten knappen Prøv det eller Kør. Eksempler:

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

gengives på følgende måde:

New-AzResourceGroup -Name myResourceGroup -Location westeurope

And

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

gengives som:

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

Hvis du vil slå denne funktion til for en bestemt kodeblok, skal du bruge en speciel identifikator for computersprog. De tilgængelige indstillinger er:

• azurepowershell-interactive – Aktiverer Azure PowerShell Cloud Shell som i det foregående eksempel
• azurecli-interactive – Aktiverer Azure Cloud Shell
• csharp-interactive – Aktiverer C# REPL

I forbindelse med Azure Cloud Shell og PowerShell Cloud Shell kan brugere kun køre kommandoer i forhold til deres egen Azure-konto.

Kodestykker inkluderet ved at referere til en kodefil

Du kan aktivere interaktiv tilstand for kodestykker, der inkluderes som reference. Hvis du vil slå denne funktion til for en bestemt kodeblok, skal du bruge attributten interactive. De tilgængelige attributværdier er:

• cloudshell-powershell – Aktiverer Azure PowerShell Cloud Shell som i det foregående eksempel
• cloudshell-bash – Aktiverer Azure Cloud Shell
• try-dotnet – Aktiverer Try .NET
• try-dotnet-class – Aktiverer Try .NET med klassestruktur
• try-dotnet-method – Aktiverer Try .NET med metodestruktur

Her er nogle eksempler:

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

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

I forbindelse med Azure Cloud Shell og PowerShell Cloud Shell kan brugerne kun køre kommandoer i forhold til deres egen Azure-konto.

I forbindelse med .NET Interactive-oplevelsen afhænger indholdet af din kodeblok af, hvilken af de tre strukturer du vælger:

• Ingen stillads (try-dotnet): Kodeblokken skal repræsentere en fuld programtekst. Filen Program.cs, der genereres af dotnet new console, bør f.eks. være gyldig. Disse er mest nyttige i forbindelse med visningen af et helt lille program, herunder de påkrævede using-direktiver. Erklæringer på øverste niveau understøttes ikke på nuværende tidspunkt.
• Metodestruktur (try-dotnet-method): Kodeblokken skal repræsentere indholdet af en Main metode i et konsolprogram. Du kan antage de using-direktiver, der tilføjes af dotnet new console-skabelonen. Denne indstilling er mest nyttig i forbindelse med korte stykker, der demonstrerer én funktion.
• Klassestruktur (try-dotnet-class): Kodeblokken skal repræsentere en klasse med en Main metode som indgangspunkt. Disse kan bruges til at vise, hvordan medlemmer af en klasse interagerer.

Syntaksreference til kodestykke

Syntaks:

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

Vigtigt

Denne syntaks er en Markdown-udvidelse af en blok. Den skal bruges på en selvstændig linje.

• <language> (valgfrit)

  • Sproget for kodestykket. Du kan få flere oplysninger i afsnittet Understøttede sprog senere i denne artikel.

• <path> (obligatorisk)

  • Relativ sti i filsystemet, der angiver filen med kodestykket som reference.

• <attribute> og <attribute-value> (valgfri)

  • Bruges sammen til at angive, hvordan koden skal hentes fra filen, og hvordan den skal vises:
    • range: 1,3-5 En række linjer. Dette eksempel omfatter linjerne 1, 3, 4 og 5.
    • id: Create Id'et for det kodestykke, der skal indsættes fra kodefilen. Denne værdi kan ikke eksistere sammen med området.
    • highlight: 2-4,6 Interval og/eller antal linjer, der skal fremhæves i det genererede kodestykke. Nummereringen står i forhold til de linjer, der vises (som angivet af interval eller id), og ikke filen.
    • interactive: cloudshell-powershell, cloudshell-bash, try-dotnet, try-dotnet-class, try-dotnet-method Strengværdien bestemmer, hvilke former for interaktivitet der er aktiveret.
    • Læs mere om gengivelse af kodenavne i kildefiler med kodestykker efter sprog i retningslinjerne for DocFX.

Understøttede sprog

Learn Authoring Pack indeholder en funktion til angivelse af fuldførelse og validering af de tilgængelige sprog-id'er for kodehegnsblokke.

Indhegnede kodeblokke

Navn	Gyldige aliasser
.NET Core CLI	dotnetcli
1C	1c
ABNF	abnf
Access logs	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, , mawknawk,gawk
Axapta	axapta
AzCopy	azcopy
Azure CLI	azurecli
Azure CLI (Interactive)	azurecli-interactive
Azure PowerShell	azurepowershell
Azure Powershell (Interactive)	azurepowershell-interactive
Bash	bash, , , shzsh
Grundlæggende	basic
BNF	bnf
O	c
C#	csharp, cs
C# (Interactive)	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
DNS Zone file	dns, , , zonebind
DOS	dos, , , batcmd
Dart	dart
Delphi	delphi, , dfmdpr, pas, pascal, freepascal, lazarus, , lprlfm
Diff	diff, patch
Django	django, jinja
Dockerfile	dockerfile, docker
dsconfig	dsconfig
DTS (Device Tree)	dts
Dust	dust, dst
Dennis	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
Handlebars	handlebars, , hbshtml.hbs,html.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
Leaf	leaf
Lasso	lasso, , , lslassoscript
Mindre end	less
LDIF	ldif
Lisp	lisp
LiveCode Server	livecodeserver
LiveScript	livescript, ls
Lua	lua
Makefile	makefile, , , mkmak
Markdown	markdown, , mdmkdown,mkd
Mathematica	mathematica, , , mmawl
Matlab	matlab
Maxima	maxima
Maya Embedded Language	mel
Mercury	mercury
mIRC Scripting Language	mirc, mrc
Mizar	mizar
Managed Object Format	mof
Mojolicious	mojolicious
Monkey	monkey
Moonscript	moonscript, moon
MS Graph (Interactive)	msgraph-interactive
N1QL	n1ql
NSIS	nsis
Nginx	nginx, nginxconf
Nimrod	nimrod, nim
Nix	nix
OCaml	ocaml, ml
Objective C	objectivec, , mmobjc,obj-c
OpenGL Shading Language	glsl
OpenSCAD	openscad, scad
Oracle Rules Language	ruleslanguage
Oxygene	oxygene
PF	pf, pf.conf
PHP	php, , php3php4, php5php6
Parser3	parser3
Perl	perl, , , plpm
Plaintext no highlight	plaintext
Pony	pony
PostgreSQL & PL/pgSQL	pgsql, , , postgrespostgresql
PowerShell	powershell, ps
PowerShell (Interactive)	powershell-interactive
Forarbejdning	processing
Prolog	prolog
Egenskaber	properties
Protocol Buffers	protobuf
Puppet	puppet, pp
Python	python, , , pygyp
Python profiler results	profile
Q#	qsharp
K	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 spec files	rpm-specfile, , rpmspec, rpm-specspecfile
Ruby	ruby, , rbgemspec, podspec, , thor,irb
Rust	rust, rs
SAS	SAS, sas
SCSS	scss
SQL	sql
STEP Part 21	p21, , , stepstp
Skalering	scala
Skema	scheme
Scilab	scilab, sci
Shape Expressions	shexc
Shell	shell, console
Smali	smali
Smalltalk	smalltalk, st
Solidity	solidity, sol
Stan	stan
Stata	stata
Structured Text	iecst, , sclstl,structured-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, , xhtmlrss, atom, xjb, xsd, xsl,plist
YAML	yml, yaml
Zephir	zephir, zep

Tip

Funktionen Learn Authoring Pack, Dev Lang Completion bruger det første gyldige alias, når der er flere tilgængelige aliaser.

Næste trin

Du kan finde oplysninger om tekstformatering til indholdstyper, der ikke er kode, i Retningslinjer for tekstformatering.