Документация Framework как JavaDoc для Objective C

Question

Имеет ли Objective C структуру документации, похожую на JavaDoc, где документация может быть сгенерирована из исходного кода?

Answer 1

Doxygen! Вы можете использовать его для многих языков, в том числе Objective-C

Answer 2

Doxygen довольно популярен среди разработчиков Obj-C.

Answer 3

Вы могли бы посмотреть на HeaderDoc Wich является основой документации яблоко похож на Java.

Answer 4

Appledoc стал очень популярен. , , версия 1 была основана на Doxygen, тогда как версия 2 была написана с нуля.

Он не обладает всеми функциями Doxygen (диаграммы, перечисления, классы C++ и т. Д.), Но то, что он предлагает, - это красиво отформатированные документы в формате HTML интегрированного формата IDE.

Также интересно отметить следующее:

• Инструмент CocoaPods включает Appledoc документацию для библиотек, которые он устанавливает. Очень удобно.

Answer 5

Хорошая новость для всех! : D Наконец, после долгого ожидания Apple представила парсерные комментарии для наших проектов. Согласно new features в XCode 5:

проектной документации из справочной документации рамки API и структурированные комментарии в своем исходном коде, отображаются в панели быстрого помощи и кода завершения просмотров поповер. Doxygen и HeaderDoc структурированные комментарии поддерживаются форматами.

и из примечаний Clang 3.2 выпуска:

Clang анализирует комментарии и может обнаружить синтаксические и семантические ошибки в комментариях. По умолчанию эти предупреждения отключены. Pass -Wdocumentation флаг для включения предупреждений о комментариях к документации.

Если вы хотите увидеть пример этой новой функции я рекомендую вам взглянуть на следующие статьи: Documentation in Xcode 5