Documentation
Les sujets

Introduction

Créer un sujet

Utilisez les étapes suivantes pour créer un sujet:

1. Cliquez sur Create New Topic dans le tableau de bord de la balise.
2. Nommez le sujet.
3. Fournissez des exemples détaillés dans la section "Exemples".
4. Si vous avez plus à partager, utilisez les sections "Syntaxe", "Paramètres" et "Remarques".

Vous avez créé un sujet avec succès! Le sujet sera accessible à tous et chacun pourra le modifier.

Rappelez-vous que dans Stack Overflow Documentation, les exemples sont la vedette du spectacle!

Anatomie d'un sujet

Un sujet est composé de plusieurs sections:

Titre: Quel est le sujet du sujet? Recherchez d'abord les sujets existants pour vous assurer de ne pas répéter le contenu existant. Les sujets déjà abordés ailleurs sur Stack Overflow peuvent être supprimés.

Versions: Les versions où le matériau couvert par le sujet s'applique. Vous pouvez choisir parmi les versions répertoriées dans la rubrique d'introduction ou les supprimer toutes pour indiquer que le sujet s'applique à toutes les versions. Voir les versions pour plus d'informations.

Introduction (facultatif): Explique le principe d'organisation des exemples contenus aux lecteurs et aux contributeurs. Il réside au-dessus des exemples et est limité à 500 caractères.

Exemples: exemples de code pour le sujet. Le code doit être facile à lire et à commenter. Prose devrait également être utilisé pour expliquer les concepts nécessaires à la compréhension du code, mais essayez de ne pas être trop verbeux.

Un exemple par sujet peut être "épinglé", ce qui signifie qu'il flotte au-dessus des autres exemples. Cela peut être utile pour une introduction prolongée qui est trop longue pour la section Introduction.

Syntaxe (facultatif): il peut être approprié d'inclure une syntaxe pour le sujet en question. Cette section est toujours un bloc de code et doit être une liste de démarques:

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

Paramètres (facultatif) : Lorsque vous décrivez un sujet comme avec la syntaxe, il peut également être approprié d'inclure des détails sur les paramètres. Les paramètres sont formatés sous la forme d'un tableau à deux colonnes:

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

Remarques (facultatif) : Toute information supplémentaire sur le sujet qui peut s'avérer utile pour le lecteur final. Les remarques sont libres.

Le sujet d'introduction

Lorsqu'une nouvelle balise de documentation est créée, StackOverflow génère automatiquement un sujet d'introduction , agissant comme un espace réservé pour le premier sujet réel.

La rubrique introductive contient des textes de substitution et des pointeurs vers des contributeurs dans les bonnes directions pour aider à développer la nouvelle balise de documentation.

Veuillez noter que les sujets d'introduction ne peuvent pas être supprimés. Voir cette question