Documentation
Onderwerpen

Invoering

Een onderwerp maken

Gebruik de volgende stappen om een onderwerp te maken:

1. Klik op Create New Topic op het dashboard van de tag.
2. Geef het onderwerp een naam.
3. Geef gedetailleerde voorbeelden in de sectie 'Voorbeelden'.
4. Als u meer wilt delen, gebruikt u de secties "Syntaxis", "Parameters" en "Opmerkingen".

U hebt met succes een onderwerp gemaakt! Het onderwerp is voor iedereen beschikbaar en iedereen kan het bewerken.

Vergeet niet dat in Stack Overflow Documentation voorbeelden de ster van de show zijn!

Anatomie van een onderwerp

Een onderwerp bestaat uit verschillende secties:

Titel: Wat is het onderwerp van het onderwerp. Zoek eerst in bestaande onderwerpen om ervoor te zorgen dat u geen inhoud herhaalt die al bestaat. Onderwerpen die al elders in Stack Overflow worden behandeld, kunnen worden verwijderd.

Versies: de versies waarop het materiaal waarop het onderwerp betrekking heeft van toepassing is. U kunt kiezen uit een van de versies die in het introductieonderwerp worden vermeld, of ze allemaal verwijderen om aan te geven dat het onderwerp op alle versies van toepassing is. Zie Versies voor meer informatie.

Inleiding (optioneel): legt het organiserende principe van de opgenomen voorbeelden uit aan zowel lezers als bijdragers. Het bevindt zich boven de voorbeelden en is beperkt tot 500 tekens.

Voorbeelden: codevoorbeelden voor het onderwerp. De code moet gemakkelijk te lezen en goed becommentarieerd zijn. Proza moet ook worden gebruikt om de concepten uit te leggen die nodig zijn om de code te begrijpen, maar probeer niet te uitgebreid te zijn.

Een voorbeeld per onderwerp kan worden "vastgezet", wat betekent dat het boven de andere voorbeelden zweeft. Dit kan handig zijn voor een uitgebreide intro die te lang is voor het gedeelte Inleiding.

Syntaxis (optioneel): het kan geschikt zijn om een syntaxis op te nemen voor het betreffende onderwerp. Deze sectie is altijd een codeblok en moet een lijst met markeringen zijn:

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

Parameters (optioneel) : bij het beschrijven van een onderwerp zoals met syntax, kan het ook passend zijn om parameterdetails op te nemen. Parameters worden opgemaakt als een tabel met twee kolommen:

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

Opmerkingen (optioneel) : aanvullende informatie over het onderwerp die waardevol kan zijn voor de eindlezer. Opmerkingen zijn freeform.

Het inleidende onderwerp

Wanneer een nieuwe documentatietag wordt gemaakt, genereert StackOverflow automatisch een inleidend onderwerp , dat als een tijdelijke aanduiding voor het eerste werkelijke onderwerp fungeert.

Het inleidende onderwerp bevat plaatsaanduidingsteksten en aanwijzingen om bijdragers in de juiste richting te wijzen om de nieuwe documentatie-tag uit te breiden.

Let op: inleidende onderwerpen kunnen niet worden verwijderd. Zie deze vraag