Documentation
темы

Вступление

Создание темы

Для создания темы выполните следующие действия:

1. Нажмите « Create New Topic на панели инструментов тега.
2. Назовите тему.
3. Предоставьте подробные примеры в разделе «Примеры».
4. Если вам нужно больше поделиться, используйте разделы «Синтаксис», «Параметры» и «Примечания».

Вы успешно создали тему! Тема будет доступна всем, и каждый может ее отредактировать.

Помните, что в документации по переполнению стека примеры - звезда шоу!

Анатомия темы

Тема состоит из нескольких разделов:

Название: Что является предметом темы. Сначала найдите существующие темы, чтобы убедиться, что вы не повторяете контент, который уже существует. Темы, уже рассмотренные в другом месте, могут быть удалены.

Версии: версии, в которых применяется материал, охватываемый темой. Вы можете выбрать любую из версий, перечисленных в разделе введения, или удалить их все, чтобы указать, что тема применима ко всем версиям. Дополнительную информацию см. В разделе « Версии» .

Введение (необязательно): Объясняет организационный принцип содержащихся примеров как читателям, так и участникам. Он находится над примерами и ограничен 500 символами.

Примеры: примеры кода для этой темы. Код должен быть легко читаемым и прокомментированным. Проза также должна использоваться для объяснения понятий, необходимых для понимания кода, но старайтесь не быть чрезмерно многословными.

Один пример для каждой темы может быть «закреплен», то есть он плавает над другими примерами. Это может быть полезно для расширенного ввода, слишком длинного для раздела «Введение».

Синтаксис (необязательно): Может быть целесообразным включить синтаксис для данной темы. Этот раздел всегда является кодовым блоком и должен быть уцененным списком:

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

Параметры (необязательно) : при описании темы, как с синтаксисом, может также быть целесообразным включить данные параметров. Параметры форматируются как таблица с двумя столбцами:

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

Замечания (необязательно) : Любая дополнительная информация о теме, которая может оказаться полезной для конечного читателя. Замечания - произвольная форма.

Вводная тема

Когда создается новый тег документа, StackOverflow автоматически генерирует вводную тему , выступая в качестве заполнителя первой актуальной темы.

В вводной теме содержатся тексты и указатели заполнителей для указания участников в правильных направлениях для содействия расширению нового тега документации.

Обратите внимание, что вводные темы не могут быть удалены. См. Этот вопрос