Есть ли общепринятый генератор документации для Objective-C (аналогично RDoc для Ruby)? Я видел Doxygen и ObjcDoc, и мне интересно, что наиболее широко используется.
Документация-генератор для Objective-C?
Ответ 1
Doxygen, вероятно, наиболее широко используемый вариант. Поскольку это не только для ObjC (doxygen поддерживает многие другие языки), разработка идет активно, а сообщество достаточно сильное. HeaderDoc (в настоящее время проект с открытым исходным кодом), по сравнению с ним, по-видимому, в значительной степени застоялся HeaderDoc производит только вывод HTML, в то время как doxygen также производит PDF, LaTeX и многие другие формы вывода помимо HTML. Кажется, даже Apple рекомендует doxygen с этим руководством по автоматическому созданию наборов документации, совместимых со средством просмотра справки Xcode, в процессе сборки Xcode.
Стоит отметить, что doxygen может читать комментарии в стиле HeaderDoc, поэтому вы можете написать свою документацию в стиле HeaderDoc и позже решить, производить ли окончательный вывод с использованием doxygen или HeaderDoc.
Ответ 2
Отъезд appledoc. Он основан на Doxygen. Вы можете видеть, что он ест свою собачью пищу, создавая справочную документацию appledoc для исходный код appledoc. Сравните, например, GBComment.h
с GBComment
Ссылка на класс.
Кроме того, ознакомьтесь с Руководство по настройке документации Xcode для подробных инструкций о том, как создавать документацию, которая работает с Xcode. Это инструкции, которые appliedoc автоматизирует.
Ответ 3
Доксиген очень широко используется. Кажется, я использую его как ответ SO примерно раз в неделю.
Ответ 4
Новый инструмент Jazzy от Realm, который генерирует документацию в новом стиле Xcode 6 и поддерживает создание документации Swift (также как Objective-C).
Ответ 5
Как и doxygen, у яблока есть инструмент, который поставляется с инструментами разработки. Он генерирует тип документации, которую вы видите на таких вещах, как структура SystenConfiguration. Инструмент называется HeaderDoc, документацию можно найти в Руководство пользователя HeaderDoc.
Ответ 6
Возможно, вам стоит попробовать jazzy Realm. Это проект с открытым исходным кодом. jazzy
поддерживает как Objective-C, так и Swift.
"Результат соответствует внешнему виду официальной справочной документации по яблокам, после WWDC 2014." Что вы можете судить по примерному документу, который он предоставляет.