Documentation
Tematy

Wprowadzenie

Tworzenie tematu

Wykonaj następujące kroki, aby utworzyć temat:

1. Kliknij opcję Create New Topic na pulpicie nawigacyjnym tagu.
2. Nazwij temat.
3. Podaj szczegółowe przykłady w sekcji „Przykłady”.
4. Jeśli masz więcej do udostępnienia, użyj sekcji „Składnia”, „Parametry” i „Uwagi”.

Pomyślnie utworzyłeś temat! Temat będzie dostępny dla wszystkich i każdy może go edytować.

Pamiętaj, że w dokumentacji przepełnienia stosu przykłady są gwiazdą serialu!

Anatomia tematu

Temat składa się z kilku sekcji:

Tytuł: Jaki jest przedmiot tematu. Najpierw przeszukaj istniejące tematy, aby upewnić się, że nie powtarzasz już istniejących treści. Tematy już omówione w innym miejscu w przepełnieniu stosu mogą zostać usunięte.

Wersje: wersje, w których ma zastosowanie materiał objęty tematem. Możesz wybrać dowolną z wersji wymienionych w temacie wstępnym lub usunąć je wszystkie, aby wskazać, że temat dotyczy wszystkich wersji. Zobacz Wersje, aby uzyskać więcej informacji.

Wprowadzenie (opcjonalnie): wyjaśnia zasadę organizowania zawartych przykładów zarówno czytelnikom, jak i autorom. Znajduje się powyżej przykładów i jest ograniczony do 500 znaków.

Przykłady: przykłady kodu dla tematu. Kod powinien być łatwy do odczytania i dobrze skomentowany. Proza powinna być również wykorzystana do wyjaśnienia pojęć potrzebnych do zrozumienia kodu, ale staraj się nie być zbyt gadatliwym.

Jeden przykład na temat można „przypiąć”, co oznacza, że przesuwa się nad innymi przykładami. Może to być przydatne w przypadku rozszerzonego wstępu, który jest zbyt długi dla sekcji Wprowadzenie.

Składnia (opcjonalnie): Może być właściwe dołączenie składni dla danego tematu. Ta sekcja jest zawsze blokiem kodu i musi być listą znaczników:

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

Parametry (opcjonalne) : opisując temat tak jak w składni, może być również właściwe dołączenie szczegółów parametru. Parametry są sformatowane jako tabela dwukolumnowa:

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

Uwagi (opcjonalnie) : Wszelkie dodatkowe informacje dotyczące tematu, które mogą okazać się cenne dla końcowego czytelnika. Uwagi są dowolne.

Temat wprowadzający

Po utworzeniu nowego znacznika dokumentacji StackOverflow automatycznie generuje temat wprowadzający , działając jako symbol zastępczy dla pierwszego rzeczywistego tematu.

Temat wprowadzający zawiera teksty zastępcze i wskazówki do kierowania autorów w odpowiednich kierunkach, aby pomóc w rozwijaniu nowego znacznika dokumentacji.

Pamiętaj, że tematów wprowadzających nie można usunąć. Zobacz to pytanie