Документация — различия между версиями
Материал из DevelopmenOnTheEdge
Lan (обсуждение | вклад) (Новая страница: «Редактирование документации Многие элементы в Структура проек…») |
Lan (обсуждение | вклад) м (Lan переименовал страницу Documentation в Документация без оставления перенаправления: По-русски) |
||
| (не показана одна промежуточная версия этого же участника) | |||
| Строка 1: | Строка 1: | ||
[[Файл:DocumentationEditing.png|thumb|Редактирование документации]] | [[Файл:DocumentationEditing.png|thumb|Редактирование документации]] | ||
| − | Многие элементы в [[Структура проекта|дереве проекта]] поддерживают документацию: вы можете написать произвольный сопроводительный текст. В интерфейсе для этого есть вкладка Documentation: достаточно выделить в дереве проекта элемент, который вы хотите документировать, и написать текст во вкладке. | + | [[:Категория:Элементы с поддержкой документации|Многие элементы]] в [[Структура проекта|дереве проекта]] поддерживают документацию: вы можете написать произвольный сопроводительный текст. В интерфейсе для этого есть вкладка Documentation: достаточно выделить в дереве проекта элемент, который вы хотите документировать, и написать текст во вкладке. |
Помимо просто текста можно автоматически создавать задачи, если написать в документации <code>@todo</code>, <code>@check</code> или <code>@pending</code>. Текст после этой метки автоматически попадёт в [[Tasks|список задач]] проекта. | Помимо просто текста можно автоматически создавать задачи, если написать в документации <code>@todo</code>, <code>@check</code> или <code>@pending</code>. Текст после этой метки автоматически попадёт в [[Tasks|список задач]] проекта. | ||
Документация сериализуется в [[yaml]]-элемент doc внутри соответствующего родительского элемента. | Документация сериализуется в [[yaml]]-элемент doc внутри соответствующего родительского элемента. | ||
Текущая версия на 17:17, 19 сентября 2014
Многие элементы в дереве проекта поддерживают документацию: вы можете написать произвольный сопроводительный текст. В интерфейсе для этого есть вкладка Documentation: достаточно выделить в дереве проекта элемент, который вы хотите документировать, и написать текст во вкладке.
Помимо просто текста можно автоматически создавать задачи, если написать в документации @todo, @check или @pending. Текст после этой метки автоматически попадёт в список задач проекта.
Документация сериализуется в yaml-элемент doc внутри соответствующего родительского элемента.
