Платформа документации, такая как JavaDoc для Objective C

Question

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

Answer 1

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

Answer 2

Хорошие новости для всех! : D Наконец-то после долгого ожидания Apple представила парсер комментариев для наших проектов. В соответствии с новыми функциями в XCode 5:

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

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

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

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

Answer 3

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

Answer 4

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

Answer 5

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

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

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

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