Xcode Documentation Generator

Question

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

Answer 1

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

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

Answer 2

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

Answer 3

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

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

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

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