Ссылка формата разметки детской площадки
Добавьте, что богатые комментарии к Вашим детским площадкам с помощью синтаксиса разметки на основе знакомых соглашений форматирования Скидки с цены для заголовков, маркированных списков, соединяются и т.д.
Редактирование комментариев
Редактирование комментирует в необработанном режиме редактирования для детской площадки. Режимы изменения для предварительного просмотра изменений путем выбора Editor> Show Rendered Markup. Переключитесь назад на необработанный режим редактирования путем выбора Editor> Show Raw Markup.
Синтаксис комментария разметки
Следующие заполнители используются всюду по определениям синтаксиса для элементов, следующих за разделителем.
| Любой допустимый повышенный в цене текст. |
| Строка раньше комментировала разметку. Когда детская площадка находится в режиме обогащенного текста, строка не выведена на экран. |
| Строка символов. Для встроенных элементов первые и последние символы не должны быть пробелами. |
| Любое допустимое целое число. |
| Пустая строка. |
Разделители разметки
Элементы разметки в детских площадках разграничены или на линию за линией основание или в блоке.
Однострочный разделитель
Добавьте одну строку разметки к документу с помощью однострочного разделителя. Многократные непрерывные строки разделителей обрабатываются как единственный богатый комментарий. Должно быть точно одно пространство между однострочным разделителем и первым символом текста.
//: <valid marked up text>
Пример
//: This is a line of text that will appear as a rich comment in a playground. |
//: These two lines of single delimiter text |
//: show up as one rich comment block in the playground |
Блочный разделитель
Включите многократные строки разметки с помощью блочного разделителя.
/*: <optional comment>
<valid marked up text>
<valid marked up text>
…
*/
Пример
/*: A comment that is not displayed in rich text view |
# The First Heading Shown |
The first content line displayed in this block of rich text. |
*/ |
Блочные элементы
Блочные элементы управляют форматированием одной или более строк комментариев детской площадки.
Заголовки
Используйте знак номера (#
) указать до трех уровней заголовка. Должно быть по крайней мере одно пространство между знаком номера и строкой заголовка.
Заголовок 1 |
|
Заголовок 2 |
|
Заголовок 3 |
|
Альтернатива
Подчеркните возглавляющую строку для уровня один и два заголовка. Число символов в заголовке и в строке подчеркивания должно быть тем же.
Заголовок 1 |
Подчеркните, что текст заголовка с равняется знаку ( Число ( |
Заголовок 2 |
Подчеркните текст заголовка с помощью дефисов ( Число ( |
Примеры
Создайте уровень два заголовка с помощью знака номера.
//: ## This is a Heading 2 |
Создайте уровень, один заголовок с помощью равняется знаку. Обратите внимание на то, что число знаков «равно» совпадает с числом символов в возглавляющей строке.
//: This is a Heading 1 |
//: =================== |
Списки
Добавьте маркируемые и пронумерованные списки с помощью языка разметки детской площадки.
Маркированные списки
Используйте звездочку (*
) для каждого маркированного элемента. Должно быть точно одно пространство между звездочкой и строкой элемента.
* <string>
Пример
/*: A bulleted list of 2 items |
* Item 1 |
* Item 2 |
*/ |
Пронумерованные списки
Каждый элемент в пронумерованном списке запускается с одних или более пробелов, целое число, сопровождаемое периодом (.
), и затем требуемый текст. Должно быть точно одно пространство между периодом и строкой элемента.
Число пробелов перед целым числом указывает уровень элемента в списке. Все первые элементы уровня запускаются с одного пространства. Добавьте четыре пробелов для каждого дополнительного уровня максимум к трех уровней.
Целое число, используемое на первой строке уровня списка, используется в качестве начального значения индекса в представлении обогащенного текста.
Пронумерованный уровень 1 списка |
|
Пронумерованный уровень 2 списка |
4 пробелов |
Пронумерованный уровень 3 списка |
8 пробелов |
Примеры
/*: A numbered list with 2 levels |
1. Cat |
2. Dog |
1. Golden Retriever |
3. Llama |
*/ |
/*: Start the numbering of the rich text list at "4" |
4. Fish |
5. Lizard |
*/ |
Второй пример выше запусков нумерация списка в 4 как показано:
Блок цитирования
Запустите каждую строку блока цитирования с большим - чем знак ([>
]). Должно быть точно одно пространство между большим - чем знак и строкой элемента.
> <string>
Пример
/*: A block quote of the first four lines from a great prologue |
> Oh for a Muse of fire, that would ascend |
> The brightest heaven of invention, |
> A kingdom for a stage, princes to act |
> And monarchs to behold the swelling scene! |
*/ |
Блок кода
Запустите каждую строку блока кода по крайней мере с четырьмя пробелами.
<string>
Пример
/*: How not to write a loop in Swift |
while true { |
println("When will this stop?") |
} |
*/ |
Встроенные элементы
Встроенные элементы формата элементов в блочных элементах. Можно использовать встроенные элементы для добавления акцента, изображений или ссылок к другим ресурсам.
Акцент
Добавьте акцент при помощи звездочки (*
) или подчеркивание (_
) в запуске и конце строки. Не смешивайте звездочки и подчеркивания для того же элемента.
*<string>*
Альтернатива
_<string>_
Пример
//: This line has a word with *emphasis* |
//: This line uses _emphasis for the last six words_ |
Сильный
Добавьте сильное форматирование с двумя звездочками (**
) или два подчеркивания (__
) в запуске и конце строки. Не смешивайте звездочки и подчеркивания для того же элемента.
**<string>**
Альтернатива
__<string>__
Пример
//: A **strong * (asterisk)** is on this line |
//: __A strong line__ |
Код
Текст формата как код при помощи обратной галочки (`
) вначале и конец строки.
`<string>`
Пример
//: Show Swift elements such as `for` and `let` as monspaced code font |
Изображение
Включайте изображения от сети или из Вашего проекта детской площадки.
![<alt text>](<URL> "<image title for hover>")
| Если изображение не загружается, текст вывел на экран. Также используемый для доступности. |
| Адрес изображения. Это может быть веб-URL или путем к файлу в проекте детской площадки. |
| Когда указатель нависает над изображением, текст вывел на экран. Также используемый для доступности. |
Примеры
Ссылка к изображению в сети с текстом парения.
//: ![Icon for a playground](http://devimages.apple.com.edgekey.net/swift/images/playgrounds.png "An image I seesawed") |
Ссылка к ресурсу детской площадки без текста парения.
//: ![Anyone for tennis?](tennis.jpg) |
Ссылка
Включайте ссылки к веб-ресурсам.
[<text to display>](<http URL>)
| Текст выведен на экран в комментарии детской площадки. |
| Адрес для веб-страницы для открытия, когда щелкают по ссылке в комментарии. |
Пример
/*: Include a link to the Swift page in the text |
See more about Swift by [following this link.](http://developer.apple.com/swift/) |
*/ |
Прочие условия
Горизонтальное правило
Используйте четыре или больше дефиса (-
) окруженный пустыми строками для добавления горизонтального правила.
<blank line>
----
<blank line>
Пример
/*: A block of markup code showing a single horizontal line |
---- |
*/ |
Escape наклонной черты влево
Выведите на экран специальные символы путем выхода из них с наклонной чертой влево (\
). Необходимо использовать наклонную черту влево для отображения специального символа в следующих случаях.
Разделитель является первым специальным символом строки разметки.
Разделитель является первым специальным символом блочного элемента.
Период является специальным символом для пронумерованного списка.
Встроенный разделитель в запуске или конце строки символов.
Вы не должны выходить из специальных символов в блоке кода, или обратная галочка разграничила код.
Для списка специальных символов посмотрите Символы Синтаксиса Комментария
\<special character>
Пример
//: Show the *middle asterisk\* with emphasis* |
Прокомментируйте сводку синтаксиса
Следующая таблица суммирует каждый оператор синтаксиса комментария.
Элемент | Синтаксис |
---|---|
Единственный разделитель строки комментария |
|
Блочный разделитель комментария |
|
Заголовок 1 |
Альтернатива
|
Заголовок 2 |
Альтернатива
|
Заголовок 3 |
|
Маркированный список |
|
Пронумерованный уровень 1 списка |
|
Пронумерованный уровень 2 списка |
4 пробелов |
Пронумерованный уровень 3 списка |
8 пробелов |
Блок цитирования |
|
Блочная строка кода |
По крайней мере 4 пробелов |
Акцент |
Альтернатива
|
Сильный |
Альтернатива
|
Код |
|
Изображение |
|
Ссылка |
|
Горизонтальное правило |
|
Escape наклонной черты влево |
|
Символы синтаксиса комментария
Комментарий детской площадки использует много символов в качестве разделителей элемента. В следующей таблице перечислены каждый специальный символ и для чего это используется.
Символ | Имя персонажа | Элементы синтаксиса |
---|---|---|
| Восклицательный знак | |
| Знак номера | |
| Открывающая скобка | |
| Близкая круглая скобка | |
| Звездочка | |
| Дефис | |
| Наклонная черта вправо | |
| Двоеточие | |
| Равняется знаку | |
| Больше - чем | |
| Открытая квадратная скобка | |
| Близкая квадратная скобка | |
| Наклонная черта влево | |
| Подчеркивание | |
| Одинарная левая кавычка (также названный серьезным диакритическим знаком) | |
| Период, которому предшествует целое число |