Документация

Материал из DevelopmenOnTheEdge
Версия от 17:02, 19 сентября 2014; Lan (обсуждение | вклад)

(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)
Перейти к: навигация, поиск
Редактирование документации

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

Помимо просто текста можно автоматически создавать задачи, если написать в документации @todo, @check или @pending. Текст после этой метки автоматически попадёт в список задач проекта.

Документация сериализуется в yaml-элемент doc внутри соответствующего родительского элемента.