2011-12-26 3 views
2

Я рассмотрел Headerdoc и Doxygen для документирования исходного кода, но им как-то нужно, чтобы разработчик выполнял большую часть работы с ногами. В Visual Studio ввод \\\ генерирует скелет для документации, включая параметры, ожидаемые методом. Также есть Ghostdoc, который догадывается, что этот метод использует на основе его имени и параметров. Есть ли что-то подобное для Xcode?Генератор документации Xcode

ответ

1

Существует также Appledoc, который создает разнообразную документацию из комментариев в вашем источнике docsets, html, который выглядит так же, как документы Apple.

+0

Но это не создает скелет документации. Я не хочу генерировать HTML-документацию, а только документацию по исходному коду. – Echilon

+0

Я так не думаю. Если вы этого не пишете, я не знаю ничего, что могло бы извлечь его из раскоментированного источника. – Abizern

0

Скачать менеджер XCode пакет: Alcatraz который можно легко сделать с помощью следующей команды:

curl -fsSL https://raw.github.com/supermarin/Alcatraz/master/Scripts/install.sh | sh 

перезапуска XCode, и вы увидите новый пункт в меню панели инструментов окна labed «Диспетчер пакетов». Затем вы можете установить VVDocumenter.

После установки VVDocumenter вам необходимо снова перезапустить XCode, но после перезагрузки Xcode вы можете ввести ///, чтобы получить помощь при написании комментариев, которые позже будут использованы для написания вашей документации.

1

Вы можете использовать плагин VVDocumenter, это очень удобный плагин для документации XCode.

После этого вы можете найти способ (или любой код), который хотите документировать, и введите ///, документ будет сгенерирован для вас, и все параметры и возврат будут извлечены в стиле Javadoc, который совместим с Appledoc, Doxygen и HeaderDoc. Вы можете просто заполнить встроенные токены для заполнения документа.

Смежные вопросы