it-swarm.xyz

Документация-генератор для Objective-C?

Существует ли общепринятый генератор документации для Objective-C (похож на RDoc для Ruby)? Я видел Doxygen и ObjcDoc, и мне интересно, что наиболее широко используется.

48
Stephen Touset

Doxygen , вероятно, наиболее широко используемый вариант. Поскольку это не только для ObjC (doxygen поддерживает многие другие языки), разработка идет активно и сообщество достаточно сильное. HeaderDoc (теперь проект с открытым исходным кодом), по сравнению с ним, по-видимому, в основном стагнировал. HeaderDoc производит только вывод HTML, в то время как doxygen также производит PDF, LaTeX и многие другие формы вывода помимо HTML. Кажется, даже Apple рекомендует doxygen с this руководством по автоматическому созданию наборов документации, совместимых со средством просмотра справки Xcode, в процессе сборки Xcode. 

Стоит отметить, что doxygen может читать комментарии в стиле HeaderDoc, поэтому вы можете написать свою документацию в стиле HeaderDoc и позже решить, производить ли окончательный вывод с использованием doxygen или HeaderDoc.

54
Barry Wark

Проверить appledoc . Он основан на Doxygen . Вы можете видеть, что он ест свой собственный корм для собак, поскольку генерирует справочную документацию appledoc для исходного кода appledoc . Сравните, например, GBComment.h с GBComment Ссылка на класс .

Кроме того, взгляните на Руководство по набору документации XCode для получения подробных инструкций о том, как создавать документацию, которая работает с XCode. Это инструкции, которые appledoc автоматизирует.

43
ma11hew28

Doxygen очень широко используется. Кажется, я использую его как ответ SO примерно раз в неделю.

6
Charlie Martin

Новый инструмент - Jazzy от Realm, который генерирует документацию в новом стиле Xcode 6 и поддерживает генерацию документации Swift (а также Objective-C).

5
James

Помимо doxygen, у Apple есть инструмент, который поставляется вместе с инструментами разработки. Он генерирует тип документации, которую вы видите в таких вещах, как инфраструктура SystenConfiguration. Инструмент называется HeaderDoc, документацию можно найти в Руководстве пользователя HeaderDoc .

4
Jason Coco

Может быть, вам стоит попробовать jazzy by Realm . Это проект с открытым исходным кодом. jazzy поддерживает Objective-C и Swift. 

«Результат соответствует внешнему виду официальной справочной документации Apple, опубликованной после WWDC 2014». Что вы можете судить по образец документа он предоставляет.

0
0xa6a