Så här inkluderar du kod i dokumentationen
Det finns flera olika sätt än skärmbilder att inkludera kod i en artikel publicerad på Microsoft Learn:
Enskilda element (ord) på en rad.
Här är ett exempel på
code-formatet.Använd kodformat när du hänvisar till namngivna parametrar och variabler i ett närliggande kodblock i din text. Du kan även använda kodformatet för egenskaper, metoder, klasser och språk. Mer information finns under Kodelement längre fram i den här artikeln.
Kodblock i artikeln Markdown-fil.
```csharp public static void Log(string message) { _logger.LogInformation(message); } ```Använd kodblock med indrag när det är opraktiskt att visa kod genom att referera till en kodfil. Mer information finns under Kodblock längre fram i den här artikeln.
Kodblock med referens till en kodfil på den lokala lagringsplatsen.
:::code language="csharp" source="intro/samples/cu/Controllers/StudentsController.cs" range="2-24,26":::Mer information finns under Referenser till kodfragment på lagringsplatsen längre fram i den här artikeln.
Kodblock med referens till en kodfil på en annan lagringsplats.
:::code language="csharp" source="~/samples-durable-functions/samples/csx/shared/Location.csx" highlight="2,5":::Mer information finns under Referenser till kodfragment utanför lagringsplatsen längre fram i den här artikeln.
Kodblock som låter användaren köra kod i webbläsaren.
:::code source="PowerShell.ps1" interactive="cloudshell-powershell":::Mer information finns under Interaktiva kodfragment längre fram i den här artikeln.
Förutom att artikeln förklarar Markdown för vart och ett av dessa sätt att inkludera kod så ger den även vissa allmänna riktlinjer för alla kodblock.
Kodelement
Ett kodelement kan vara ett nyckelord i ett programmeringsspråk, ett klassnamn, ett egenskapsnamn osv. Det är inte alltid uppenbart vad som räknas som kod. NuGet-paketnamn ska t.ex. behandlas som kod. Om du är tveksam så läs Riktlinjer för formatering av text.
Intern kodstil
Om du vill inkludera ett kodelement i artikeltexten omger du det med backticks (') för att ange kodformat. Du ska inte använda tredubbla bakstreck för intern kodstil.
| Markdown | Återges |
|---|---|
| Som standard tolkar Entity Framework en egenskap med namnet "Id" eller "ClassnameID" som primärnyckel. | Som standard tolkar Entity Framework en egenskap som har namnet Id eller ClassnameID som den primära nyckeln. |
När en artikel har lokaliserats (översatts till andra språk), lämnas text som formaterats som kod oöversatt. Om du vill förhindra lokalisering utan att använda kodstil kan du läsa Strängar som inte ska lokaliseras.
Fetstil
Vissa äldre formateringsriktlinjer anger fetstil för infogad kod. Fetstil är ett alternativ när kodformatet är så störande att det påverkar läsbarheten. En Markdown-tabell som innehåller många kodelement kan exempelvis vara svåröverskådlig. Om du väljer att använda fet stil ska du använda syntaxen för icke-lokaliserade strängar för att se till att koden inte lokaliseras.
Länkar
En länk till referensdokumentation kan vara mer användbar än kodformat i vissa situationer. Använd inte kodformat i länktexten om du använder en länk. Om en länk formateras med kod kan detta dölja det faktum att texten är en länk.
Om du använder en länk och refererar till samma element senare i samma kontext ska du använda kodformat snarare än länkar för senare förekomster. Till exempel:
The first reference to <xref:System.CommandLine> in this text is a link.
Subsequent references to `System.CommandLine` can be in code style.
Återges:
Den första referensen i System.CommandLine den här texten är en länk.
Efterföljande referenser till System.CommandLine kan vara i kodformat.
Platshållare
Om du vill att användaren ska ersätta ett avsnitt i den visade koden med sina egna värden använder du platshållartext markerad med vinkelparenteser. Till exempel:
az group delete -n <ResourceGroupName>
Observera att hakparenteserna måste tas bort när du ersätter verkliga värden. Microsofts guide för skrivstil kräver kursiv stil, som du kan formatera inom vinkelparenteserad infogad kod:
<ResourceGroupName>är resursgruppen där...
Klammerparenteser { } rekommenderas inte för användning som syntaktiska platshållare. De kan förväxlas med samma notation som används i utbytbar text, formatsträngar, stränginterpolation, textmallar och liknande programmeringskonstruktioner.
Platshållarnamn kan avgränsas med bindestreck ("kebabfall"), med understreck eller inte alls avgränsade (Pascal-skiftläge). Kebabfall kan generera syntaxfel och understreck kan vara i konflikt med understreck. All-caps kan vara i konflikt med namngivna konstanter på många språk, men det kan också uppmärksamma platshållarnamnet.
<Resource-Group-Name>eller<ResourceGroupName>
Kodblock
Syntaxen för att ta med kod i ett dokument beror på var koden finns:
Här följer några riktlinjer som gäller för samtliga tre typer av kodblock:
- Skärmdumpar
- Automatisera kodvalidering
- Markera viktiga kodrader
- Undvik vågräta rullningslister
- Identifiera felaktig kod tydligt
Skärmbilder
Alla metoder i föregående avsnitt leder till i användbara kodblock:
- Du kan kopiera och klistra in från dem.
- De indexeras av sökmotorer.
- De är tillgängliga för skärmläsare.
Det här är bara några av orsakerna till varför IDE-skärmbilder inte rekommenderas som metod för att inkludera kod i en artikel. Använd bara IDE-skärmbilder för kod om du visar något om själva IDE-filen, till exempel IntelliSense. Använd inte skärmbilder för att visa färgläggning och markeringar.
Kodvalidering
Vissa lagringsplatser har implementerat processer som automatiskt kompilerar all exempelkod i syfte att söka efter fel. Det här görs i .NET-databasen. Mer information finns i Bidra på .NET-lagringsplatsen.
Om du inkluderar kodblock från en annan lagringsplats ska du samarbeta med ägarna om en underhållsstrategi för koden, så att inte din inkluderade kod slutar fungera eller blir inaktuell när nya versioner av biblioteken som används av koden levereras.
Markera
Kodavsnitt omfattar vanligtvis mer kod än vad som krävs för att tillhandahålla ett sammanhang. Det underlättar läsbarheten om du markerar viktiga rader som du vill fokusera på i kodavsnittet, som i följande exempel:
Du kan markera koden när du inkluderar den i artikelns Markdown-fil. Det fungerar endast för kodfragment som inkluderas med referens till en kodfil.
Vågräta rullningslister
Undvik vågräta rullningslister genom att dela upp långa rader. Kodblock med rullningslister gör det svårt att läsa koden. De är särskilt problematiska när det handlar om längre kodblock där det kan vara omöjligt att samtidigt se rullningslisten och den rad som du vill läsa.
En riktlinje för att minimera antalet vågräta rullningslister i kod är att dela upp kodrader som är längre än 85 tecken. Men kom ihåg att förekomsten eller frånvaron av en rullningslist inte är det enda kriteriet för läsbarhet. Om läsbarheten försämras av att radbryta innan 85 tecken kan du använda längre rader.
Identifiera felaktig kod tydligt
I vissa scenarier är det bra att peka på kodningsmönster som bör undvikas, till exempel:
- Kod som orsakar ett kompilatorfel vid försök.
- Kod som kompileras korrekt men som inte rekommenderas.
För följande scenarier:
Förklara felet både i kodkommentar och artikeltext.
Läsare hoppar ofta över artikeltext och tittar bara på kod, så det räcker inte att bara förklara felet i artikeltexten. Det räcker inte heller att bara förklara felet i kodkommentar eftersom kodkommentarna inte är lokaliserade.
Överväg att kommentera ut koden om det skulle orsaka ett kompilatorfel.
Utkommen kod stör inte systemet för kontinuerlig integrering (CI) om artikelns lagringsplats har en nu eller implementerar en i framtiden.
Ett exempel på hur du presenterar kod som inte rekommenderas finns i Exempel på Rune-användning: ändra bokstavsfall. I det här exemplet är råden för att undvika den även inbyggda i själva koden, eftersom C#-metodnamnet är ConvertToUpperBadExample.
Interna kodblock
Använd bara interna kodblock när det är opraktiskt att visa kod genom att referera till en kodfil. Intern kod är i allmänhet svårare att testa och uppdatera jämfört med en kodfil som ingår i ett fullständigt projekt. Intern kod kan dessutom utelämna kontext som hjälper utvecklare att förstå och använda koden. De här övervägandena gäller huvudsakligen för programmeringsspråk. Du kan även använda interna kodblock för utdata och indata (som JSON), frågespråk (som SQL) och skriptspråk (som PowerShell).
Det finns två sätt att ange att ett textavsnitt i en artikelfil är ett kodblock: genom att fäkta det i triple-backticks (''') eller genom att dra in det. Att hägna in är att föredra eftersom du då kan specificera språket. Undvik att använda indrag eftersom det lätt kan bli fel, och det kan vara svårt för en annan deltagare att förstå din avsikt när de ska redigera din artikel.
Språkindikatorer placeras omedelbart efter de inledande tredubbla grava accenterna, så som i följande exempel:
Markdown:
```json
{
"aggregator": {
"batchSize": 1000,
"flushTimeout": "00:00:30"
}
}
```
Återges:
{
"aggregator": {
"batchSize": 1000,
"flushTimeout": "00:00:30"
}
}
Dricks
GitHub Flavored Markdown stöder avgränsande kodblock med tildes (~) samt med backticks ('). Symbolen som används för att öppna och stänga kodblocket måste vara konsekvent inom samma kodblock.
Information om de värden som du kan använda som indikatorer för språk finns i Språknamn och alias.
Om du använder ett språk- eller miljöord efter de trippel-backticks (''') som inte stöds visas det ordet i kodavsnittets namnlist på den renderade sidan. Om du kan så ska du använda ett språk- eller en miljö-ID i dina interna kodblock.
Kommentar
Om du kopierar och klistrar in kod från ett Word-dokument kontrollerar du att det inte har några "lockiga citattecken" som inte är giltiga i kod. Om det gör det ändrar du tillbaka dem till vanliga citattecken (' och "). Du kan också förlita dig på funktionen Learn Authoring Pack och ersätta smarta citattecken.
Kodfragmentsreferenser på lagringsplatser
Det bästa sättet att inkludera kodfragment från programmeringsspråk i dokument är genom referenser till en kodfil. Med den metoden kan du framhäva kodrader och göra kodfragmentets sammanhang tillgängligt för utvecklare på GitHub. Du kan inkludera kod med hjälp av trippelkolonformatet (:::) antingen manuellt eller i Visual Studio Code med hjälp av Learn Authoring Pack.
- I Visual Studio Code klickar du på Alt + M eller Alternativ + M och väljer Kodfragment.
- När kodfragmentet är markerat uppmanas du att välja mellan fullständig sökning, begränsad sökning och referens för flera lagringsplatser. Om du vill söka lokalt väljer du Fullständig sökning.
- Ange en sökterm för att hitta filen. När du har hittat filen väljer du den.
- Välj sedan ett alternativ för att bestämma vilken eller vilka rader med kod som ska ingå i kodfragmentet. Alternativen är: ID, Intervall och Ingen.
- Beroende på vad du väljer i steg 4 anger du ett värde om det behövs.
Visa hela kodfilen:
:::code language="csharp" source="intro/samples/cu/Controllers/StudentsController.cs":::
Visa en del av en kodfil genom att ange radnummer:
:::code language="csharp" source="intro/samples/cu/Controllers/StudentsController.cs" range="2-24,26":::
Visa en del av en kodfil genom att ange ett kodavsnittsnamn:
:::code language="csharp" source="intro/samples/cu/Controllers/StudentsController.cs" id="snippet_Create":::
I följande avsnitt beskrivs följande exempel:
- Använd en relativ sökväg till kodfilen
- Inkludera endast valda radnummer
- Referera till ett namngivet kodavsnitt
- Markera valda rader
Mer information finns under Syntax för kodfragment längre fram i den här artikeln.
Sökväg till kodfilen
Exempel:
:::code language="csharp" source="intro/samples/cu/Controllers/StudentsController.cs" range="2-24,26":::
Exemplet kommer från ASP.NET-dokumentens lagringsplats, artikelfilen aspnetcore/data/ef-mvc/crud.md. Kodfilen refereras till av en relativ sökväg till aspnetcore/data/ef-mvc/intro/samples/cu/Controllers/StudentsController.cs på samma lagringsplats.
Valda radnummer
Exempel:
:::code language="csharp" source="intro/samples/cu/Controllers/StudentsController.cs" range="2-24,26":::
I det här exemplet visas endast raderna 2–24 och 26 i kodfilen StudentController.cs.
Använd namngivna kodavsnitt snarare än hårdkodade radnummer, se förklaringen i nästa avsnitt.
Namngivet kodavsnitt
Exempel:
:::code language="csharp" source="intro/samples/cu/Controllers/StudentsController.cs" id="snippet_Create":::
Använd bara bokstäver och understreck för namnet.
Exemplet visar kodavsnittet snippet_Create i kodfilen. Kodfilen för det här exemplet har kodfragmentstaggar i kommentarerna i C#-koden:
// code excluded from the snippet
// <snippet_Create>
// code included in the snippet
// </snippet_Create>
// code excluded from the snippet
Namngivna kodfragment kan kapslas, enligt följande exempel:
// <Method>
public static void SomeMethod()
{
// <Line>
// Single line of code.
// </Line>
}
// </Method>
Method När kodfragmentet återges inkluderas inte taggarna Line i de renderade utdata.
Om du kan, så referera till ett namngivet avsnitt i stället för att ange radnumren. Att använda referenser till radnummer är riskfyllt eftersom kodfiler oundvikligen ändras på sätt som gör att radnumren ändras. Det är långtifrån säkert att du får information om dessa ändringar. Din artikel kommer så småningom att visa fel rader och du har ingen aning om att något har ändrats.
Markera valda rader
Exempel:
:::code language="csharp" source="intro/samples/cu/Controllers/StudentsController.cs" range="2-24,26" highlight="2,5":::
I exemplet markeras raderna 2 och 5, räknat från kodavsnittets början. Radnummer att markera räknas inte från kodfilens början. Med andra ord markeras raderna 3 och 6 i kodfilen.
Kodfragmentsreferenser utanför lagringsplats
Om kodfilen du vill referera till finns på en annan lagringsplats måste du konfigurera kodlagringsplatsen som en beroende lagringsplats. När du gör detta ger du den ett namn. Det här namnet fungerar sedan som ett mappnamn när det gäller kodreferenser.
Dokumentlagringsplatsen är t.ex. Azure/azure-docs och kodlagringsplatsen är Azure/azure-functions-durable-extension.
Lägg till följande avsnitt i openpublishing.publish.config.json i rotmappen för azure-docs:
{
"path_to_root": "samples-durable-functions",
"url": "https://github.com/Azure/azure-functions-durable-extension",
"branch": "main",
"branch_mapping": {}
},
Nu när du refererar till sample-durable-functions som om det vore en mapp i azure-docs så refererar du i själva verket till rotmappen på lagringsplatsen azure-functions-durable-extension.
Du kan inkludera kod med hjälp av trippelkolonformatet (:::) antingen manuellt eller i Visual Studio Code med hjälp av Learn Authoring Pack.
- I Visual Studio Code klickar du på Alt + M eller Alternativ + M och väljer Kodfragment.
- När kodfragmentet är markerat uppmanas du att välja mellan fullständig sökning, begränsad sökning och referens för flera lagringsplatser. Om du vill söka i flera lagringsplatser väljer du alternativet för referens för flera lagringsplatser.
- Då får du välja mellan lagringsplatser som finns i .openpublishing.publish.config.json. Välj en lagringsplats.
- Ange en sökterm för att hitta filen. När du har hittat filen väljer du den.
- Välj sedan ett alternativ för att bestämma vilken eller vilka rader med kod som ska ingå i kodfragmentet. Alternativen är: ID, Intervall och Ingen.
- Beroende på vad du väljer i steg 5 anger du ett värde.
Din kodfragmentsreferens kan se ut så här:
:::code language="csharp" source="~/samples-durable-functions/samples/csx/shared/Location.csx" highlight="2,5":::
På lagringsplatsen azure-functions-durable-extension finns den kodfilen i mappen samples/csx/shared. Som vi sade tidigare gäller radnumren för markering i förhållande till början av kodfragmentet snarare än filens början.
Kommentar
Namnet du tilldelar till den beroende lagringsplatsen är relativt roten för huvudlagringsplatsen, men tilde (~) refererar till roten i dokumentuppsättningen. Dokumentuppsättningsroten bestäms av build_source_folder i .openpublishing.publish.config.json. Sökvägen till kodfragmentet i föregående exempel fungerar för lagringsplatsen azure-docs eftersom build_source_folder refererar till roten för lagringsplatsen (.). Om build_source_folder var articles skulle sökvägen börja med ~/../samples-durable-functions i stället för ~/samples-durable-functions.
Kodfragment i en Jupyter-anteckningsbok
Du kan referera till en cell i en Jupyter Notebook som ett kodfragment. För att referera till cellen:
- Lägg till cellmetadata i anteckningsboken för de celler som du vill referera till.
- Konfigurera åtkomst till lagringsplatsen.
- Använd Jupyter Notebook-kodfragmentsyntax i markdown-filen.
Lägga till metadata i notebook-filen
Namnge cellen genom att lägga till cellmetadata i Jupyter Notebook.
- I Jupyter kan du redigera cellmetadata genom att först aktivera cellverktygsfältet: Redigera metadata i verktygsfältet > Visa > cell.
- När cellverktygsfältet har aktiverats väljer du Redigera metadata i den cell som du vill namnge.
- Eller så kan du redigera metadata direkt i anteckningsbokens JSON-struktur.
I cellmetadata lägger du till ett "namn"-attribut:
"metadata": {"name": "<name>"},Till exempel:
"metadata": {"name": "workspace"},Dricks
Du kan lägga till andra metadata som du vill hjälpa dig att spåra var cellen används. Till exempel:
"metadata": { "name": "workspace", "msdoc": "how-to-track-experiments.md" },
Konfigurera åtkomst till lagringsplats
Om notebook-filen som du vill referera till finns på en annan lagringsplats konfigurerar du kodlagringsplatsen som en beroende lagringsplats.
Syntaxreferens för Jupyter Notebook-kodfragment
När notebook-filen innehåller nödvändiga metadata refererar du till den i markdown-filen. Använd den <cell-name-value> du lade till i notebook-filen och den <path> du konfigurerade som din beroende lagringsplats.
[!notebook-<language>[] (<path>/<notebook-name.ipynb>?name=<cell-name-value>)]
Till exempel:
[!notebook-python[] (~/MachineLearningNotebooks/train-on-local.ipynb?name=workspace)]
Viktigt!
Den här syntaxen är ett Markdown-blocktillägg. Den måste användas på en egen rad.
Använd något av de språk som stöds för identifieraren<language>.
Interaktiva kodfragment
Interna interaktiva kodblock
För följande språk kan kodfragment göras körbara i webbläsarfönstret:
- Azure Cloud Shell
- Azure PowerShell Cloud Shell
- C# REPL
När interaktivt läge har aktiverats har de återgivna kodrutorna en Prova- eller Kör-knapp. Till exempel:
```azurepowershell-interactive
New-AzResourceGroup -Name myResourceGroup -Location westeurope
```
återges som följande:
New-AzResourceGroup -Name myResourceGroup -Location westeurope
och
```csharp-interactive
var aFriend = "Maria";
Console.WriteLine($"Hello {aFriend}");
```
renderas som:
var aFriend = "Maria";
Console.WriteLine($"Hello {aFriend}");
Använd en särskild språkidentifiering när du vill aktivera den här funktionen för ett visst kodblock. De tillgängliga alternativen är:
azurepowershell-interactive– Aktiverar Azure PowerShell Cloud Shell, som i föregående exempelazurecli-interactive– Aktiverar Azure Cloud Shellcsharp-interactive– Aktiverar C# REPL
När det gäller Azure Cloud Shell och PowerShell Cloud Shell kan användarna bara köra kommandona mot sina egna Azure-konton.
Kodfragment som infogas via referens
Du kan aktivera interaktivt läge för kodfragment som inkluderats som referens.
Använd interactive-attributet om du vill aktivera den här funktionen för ett visst kodblock. Följande är tillgängliga attributvärden:
cloudshell-powershell– Aktiverar Azure PowerShell Cloud Shell, som i föregående exempelcloudshell-bash– Aktiverar Azure Cloud Shelltry-dotnet– Aktiverar Try .NETtry-dotnet-class– Aktiverar Try .NET med klassramverktry-dotnet-method– Aktiverar Try .NET med metodramverk
Nedan följer några exempel:
:::code source="PowerShell.ps1" interactive="cloudshell-powershell":::
:::code source="Bash.sh" interactive="cloudshell-bash":::
När det gäller Azure Cloud Shell och PowerShell Cloud Shell kan användarna bara köra kommandon mot sina egna Azure-konton.
I .NET Interactive beror innehållet i ditt kodblock på vilket av de tre ramverken du väljer:
- Inga byggnadsställningar (
try-dotnet): Kodblocket ska representera en fullständig programtext. Till exempel är filen Program.cs som genereras avdotnet new consolegiltig. Dessa är framförallt användbara för att visa ett helt litet program, inklusiveusing-direktiven som behövs. Instruktionen på högsta nivån stöds inte ännu. - Metodställningar (
try-dotnet-method): Kodblocket ska representera innehållet i enMainmetod i ett konsolprogram. Du kan förutsätta direktivenusingsom lagts till av mallendotnet new console. Den här inställningen är framförallt användbar för korta kodfragment som demonstrerar en funktion. - Klassställningar (
try-dotnet-class): Kodblocket ska representera en klass med enMainmetod som startpunkt för programmet. Dessa kan användas för att visa hur medlemmarna i en klass interagerar.
Syntax för kodfragment
Syntax:
:::code language="<language>" source="<path>" <attribute>="<attribute-value>":::
Viktigt!
Den här syntaxen är ett Markdown-blocktillägg. Den måste användas på en egen rad.
<language>(valfritt)- Språk i kodfragmentet. Mer information finns i avsnittet om språk som stöds senare i den här artikeln.
<path>(obligatoriskt)- Relativ sökväg i filsystemet som indikerar kodfragmentfilen till referens.
<attribute>och<attribute-value>(valfritt)- Används tillsammans för att ange hur koden ska hämtas från filen och hur den ska visas:
range:1,3-5Ett intervall med rader. Det här exemplet innehåller raderna 1, 3, 4 och 5.id:CreateID:t för kodfragmentet som måste infogas från kodfilen. Det här värdet kan inte samexistera med intervallet.highlight:2-4,6Intervall och/eller antal rader som måste markeras i det genererade kodfragmentet. Numreringen är i förhållande till de rader som visas (anges med ett intervall eller ID), inte till filen.interactive:cloudshell-powershell,cloudshell-bash,try-dotnet,try-dotnet-class,try-dotnet-methodSträngvärdet avgör vilka typer av interaktivitet som aktiveras.- Information om taggnamnsrepresentation i kodfragmentets källfiler efter språk finns i riktlinjerna för DocFX.
- Används tillsammans för att ange hur koden ska hämtas från filen och hur den ska visas:
Språk som stöds
Learn Authoring Pack innehåller en funktion för att tillhandahålla komplettering av instruktioner och validering av tillgängliga språkidentifierare för kodstängselblock.
Avgränsade kodblock
| Name | Giltiga alias |
|---|---|
| .NET Core CLI | dotnetcli |
| 1C | 1c |
| ABNF | abnf |
| Åtkomstloggar | 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 (interaktivt) | azurecli-interactive |
| Azure PowerShell | azurepowershell |
| Azure Powershell (interaktivt) | azurepowershell-interactive |
| Bash | bash, , shzsh |
| Grundläggande | basic |
| BNF | bnf |
| C | c |
| C# | csharp, cs |
| C# (interaktivt) | csharp-interactive |
| C++ | cpp, c, cc, 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, coffee, , csoniced |
| 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, dpr, dfm, pas, pascal, freepascal, , lazarus, , lprlfm |
| Diff | diff, patch |
| Django | django, jinja |
| Dockerfile | dockerfile, docker |
| dsconfig | dsconfig |
| DTS (Device Tree) | 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 |
| Kör | go, golang |
| Golo | golo, gololang |
| Gradle | gradle |
| GraphQL | graphql |
| Groovy | groovy |
| HTML | html, xhtml |
| HTTP | http, https |
| Haml | haml |
| Handtag | 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 |
| Lövnod | leaf |
| Lasso | lasso, , lslassoscript |
| Mindre | 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 Scripting Language | mirc, mrc |
| Mizar | mizar |
| Managed Object Format | mof |
| Mojolicious | mojolicious |
| Monkey | monkey |
| Moonscript | moonscript, moon |
| MS Graph (interaktivt) | 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 |
| Brödtext utan markering | plaintext |
| Pony | pony |
| PostgreSQL & PL/pgSQL | pgsql, , postgrespostgresql |
| PowerShell | powershell, ps |
| PowerShell (interaktivt) | powershell-interactive |
| Bearbetning | processing |
| Prolog | prolog |
| Egenskaper | 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, rpm, spec, , , rpm-specspecfile |
| Ruby | ruby, rb, gemspec, podspec, , , thorirb |
| Rust | rust, rs |
| SAS | SAS, sas |
| SCSS | scss |
| SQL | sql |
| STEP Part 21 | p21, , stepstp |
| Scala | scala |
| Schema | scheme |
| Scilab | scilab, sci |
| Shape Expressions | shexc |
| Gränssnitt | shell, console |
| Smali | smali |
| Smalltalk | smalltalk, st |
| Solidity | solidity, sol |
| Stan | stan |
| Stata | stata |
| Strukturerad text | 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, atom, xjb, , xsd, , xslplist |
| YAML | yml, yaml |
| Zephir | zephir, zep |
Dricks
Funktionen Learn Authoring Pack, Dev Lang Completion använder det första giltiga aliaset när flera alias är tillgängliga.
Nästa steg
Du kan läsa mer om textformatering av andra innehållstyper än kod i riktlinjerna för textformatering.
Feedback
Kommer snart: Under hela 2024 kommer vi att fasa ut GitHub-problem som feedbackmekanism för innehåll och ersätta det med ett nytt feedbacksystem. Mer information finns i: https://aka.ms/ContentUserFeedback.
Skicka och visa feedback för