Я рассмотрел Headerdoc и Doxygen для документирования исходного кода, но им как-то нужно, чтобы разработчик выполнял большую часть работы с ногами. В Visual Studio ввод \\\
генерирует скелет для документации, включая параметры, ожидаемые методом. Также есть Ghostdoc, который догадывается, что этот метод использует на основе его имени и параметров. Есть ли что-то подобное для Xcode?Генератор документации Xcode
ответ
Существует также Appledoc, который создает разнообразную документацию из комментариев в вашем источнике docsets, html, который выглядит так же, как документы Apple.
Скачать менеджер XCode пакет: Alcatraz который можно легко сделать с помощью следующей команды:
curl -fsSL https://raw.github.com/supermarin/Alcatraz/master/Scripts/install.sh | sh
перезапуска XCode, и вы увидите новый пункт в меню панели инструментов окна labed «Диспетчер пакетов». Затем вы можете установить VVDocumenter.
После установки VVDocumenter вам необходимо снова перезапустить XCode, но после перезагрузки Xcode вы можете ввести ///, чтобы получить помощь при написании комментариев, которые позже будут использованы для написания вашей документации.
Вы можете использовать плагин VVDocumenter, это очень удобный плагин для документации XCode.
После этого вы можете найти способ (или любой код), который хотите документировать, и введите ///
, документ будет сгенерирован для вас, и все параметры и возврат будут извлечены в стиле Javadoc, который совместим с Appledoc, Doxygen и HeaderDoc. Вы можете просто заполнить встроенные токены для заполнения документа.
- 1. Генератор документации gRPC
- 2. Генератор документации Python
- 3. Генератор документации для Testcomplete
- 4. Генератор документации Angular2
- 5. Генератор документации .NET XSD
- 6. Генератор/редактор веб-документации
- 7. YARDoc (генератор документации) для PHP
- 8. Простейший генератор документации схемы JSON
- 9. Генератор документации API Asp.Net 5
- 10. Генератор парсеров для встроенной документации
- 11. Какой генератор документации использует Google?
- 12. Генератор документации PHP и Javascript
- 13. Генератор документации Visual Studio C++
- 14. JavaScript генератор документации Cloud9 IDE
- 15. Генератор HTML-документации для .NET
- 16. Просмотр наборов документации документации в Xcode 5?
- 17. Другие читатели документации XCode
- 18. Ошибка загрузки документации xcode
- 19. Генератор документации для файлов модели NetLogo
- 20. Генератор документации для Google Closure Javascript
- 21. Какой генератор документации используется для lodash.com
- 22. Hapi.js Генератор документации для серверов REST API
- 23. Увеличение размера шрифта в окне документации XCode
- 24. Измените язык документации быстрой справки в Xcode
- 25. Окно документации Xcode 5 невозможно сделать полноэкранным
- 26. Для чего нужны файлы документации Xcode?
- 27. Комментарии к документации по Xcode - ключевые слова
- 28. Сценарий документации Xcode с проблемами с кислородом
- 29. Элементы обновления документации Xcode, застрявшие в «Получение ...»
- 30. Почему производительность поиска документации XCode настолько ужасна?
Но это не создает скелет документации. Я не хочу генерировать HTML-документацию, а только документацию по исходному коду. – Echilon
Я так не думаю. Если вы этого не пишете, я не знаю ничего, что могло бы извлечь его из раскоментированного источника. – Abizern