Документация — различия между версиями
Материал из DevelopmenOnTheEdge
Lan (обсуждение | вклад) |
Lan (обсуждение | вклад) м (Lan переименовал страницу Documentation в Документация без оставления перенаправления: По-русски) |
(нет различий)
| |
Текущая версия на 17:17, 19 сентября 2014
Многие элементы в дереве проекта поддерживают документацию: вы можете написать произвольный сопроводительный текст. В интерфейсе для этого есть вкладка Documentation: достаточно выделить в дереве проекта элемент, который вы хотите документировать, и написать текст во вкладке.
Помимо просто текста можно автоматически создавать задачи, если написать в документации @todo, @check или @pending. Текст после этой метки автоматически попадёт в список задач проекта.
Документация сериализуется в yaml-элемент doc внутри соответствующего родительского элемента.
