Documentation
Themen

Einführung

Ein Thema erstellen

Gehen Sie folgendermaßen vor, um ein Thema zu erstellen:

1. Klicken Create New Topic im Dashboard des Tags auf Create New Topic .
2. Benennen Sie das Thema.
3. Geben Sie detaillierte Beispiele im Abschnitt "Beispiele" an.
4. Wenn Sie mehr freigeben möchten, verwenden Sie die Abschnitte "Syntax", "Parameter" und "Bemerkungen".

Du hast erfolgreich ein Thema erstellt! Das Thema steht allen zur Verfügung und kann von jedem bearbeitet werden.

Denken Sie daran, dass Beispiele in der Stack Overflow-Dokumentation der Star der Show sind!

Anatomie eines Themas

Ein Thema besteht aus mehreren Abschnitten:

Titel: Was ist das Thema des Themas? Suchen Sie zunächst nach vorhandenen Themen, um sicherzustellen, dass Sie nicht bereits vorhandenen Inhalt wiederholen. Themen, die bereits an anderer Stelle im Stapelüberlauf behandelt wurden, können gelöscht werden.

Versionen: Die Versionen, bei denen das vom Thema behandelte Material gilt. Sie können eine der im Einführungsthema aufgeführten Versionen auswählen oder alle entfernen, um anzuzeigen, dass das Thema für alle Versionen gilt. Weitere Informationen finden Sie unter Versionen .

Einführung (optional): Erläutert das Leserprinzip und das Mitwirkende des Organisationsprinzips der enthaltenen Beispiele. Sie befindet sich über den Beispielen und ist auf 500 Zeichen begrenzt.

Beispiele: Codebeispiele für das Thema. Der Code sollte einfach zu lesen und gut kommentiert sein. Prosa sollte auch verwendet werden, um die Konzepte zu erläutern, die zum Verständnis des Codes erforderlich sind, aber nicht zu ausführlich sein.

Ein Beispiel pro Thema kann "fixiert" werden, d. H. Es schwebt über den anderen Beispielen. Dies kann nützlich sein für ein erweitertes Intro, das für den Einleitungsteil zu lang ist.

Syntax (optional): Es kann angebracht sein, eine Syntax für das jeweilige Thema anzugeben. Dieser Abschnitt ist immer ein Codeblock und muss eine Abschriftenliste sein:

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

Parameter (optional) : Bei der Beschreibung eines Zweigs mit Syntax kann es auch angebracht sein, Parameterdetails einzuschließen. Parameter werden als zweispaltige Tabelle formatiert:

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

Anmerkungen (optional) : Zusätzliche Informationen zum Thema, die für den Endleser wertvoll sein können. Bemerkungen sind Freiform.

Das einführende Thema

Wenn ein neues Dokumentations-Tag erstellt wird, generiert StackOverflow automatisch ein einführendes Thema , das als Platzhalter für das erste tatsächliche Thema fungiert.

Das einführende Thema enthält Platzhaltertexte und Hinweise, um die Mitwirkenden in die richtigen Richtungen zu weisen, um das neue Dokumentations-Tag erweitern zu können.

Bitte beachten Sie, dass einführende Themen nicht gelöscht werden können. Siehe diese Frage