Documentation
ämnen

Introduktion

Skapa ett ämne

Använd följande steg för att skapa ett ämne:

1. Klicka på Create New Topic i taggens instrumentpanel.
2. Namnge ämnet.
3. Ge detaljerade exempel i avsnittet "Exempel".
4. Om du har mer att dela använder du avsnitten "Syntax", "Parametrar" och "Kommentarer".

Du har framgångsrikt skapat ett ämne! Ämnet kommer att vara tillgängligt för alla och alla kan redigera det.

Kom ihåg att exempel i Stack Overflow-dokumentation är showens stjärna!

Anatomi av ett ämne

Ett ämne består av flera avsnitt:

Titel: Vad är ämnet för ämnet. Sök först i befintliga ämnen för att se till att du inte upprepar innehåll som redan finns. Ämnen som redan behandlas någon annanstans på Stack Overflow kan raderas.

Versioner: De versioner där materialet som omfattas av ämnet gäller. Du kan välja mellan någon av versionerna i introduktionsämnet eller ta bort dem alla för att indikera att ämnet gäller alla versioner. Se versioner för mer information.

Introduktion (valfritt): Förklarar organiseringsprincipen för de innehållande exemplen för både läsare och bidragsgivare. Den ligger ovanför exemplen och är begränsad till 500 tecken.

Exempel: Koda exempel på ämnet. Koden ska vara lättläst och kommenteras väl. Prosa bör också användas för att förklara de koncept som behövs för att förstå koden, men försök att inte vara alltför ordaliga.

Ett exempel per ämne kan "fästas", vilket betyder att det flyter över de andra exemplen. Detta kan vara användbart för en utökad introduktion som är för lång för avsnittet Introduktion.

Syntax (valfritt): Det kan vara lämpligt att inkludera en syntax för det aktuella ämnet. Det här avsnittet är alltid ett kodblock och måste vara en nedlistningslista:

- class.method(required_parameter [, optional])
- function f(int x) = { code defining what the function does }

Parametrar (valfritt) : När man beskriver ett ämne som med syntax kan det också vara lämpligt att inkludera parameterdetaljer. Parametrar formateras som en tabell med två kolumner:

| Parameter | Details |  
| --------- | ------- | 
|       yin |    dark | 
|      yang |   light |

Anmärkningar (valfritt) : All ytterligare information om ämnet som kan visa sig värdefull för slutläsaren. Anmärkningar är fritt.

Det inledande ämnet

När en ny dokumentationstagg skapas genererar StackOverflow automatiskt ett inledande ämne som fungerar som en platshållare för det första faktiska ämnet.

Det inledande ämnet innehåller platshållartekster och pekare på att peka bidragsgivare i rätt riktning för att hjälpa till att utvidga den nya dokumentationstaggen.

Observera att inledande ämnen inte kan raderas. Se den här frågan