Xcode 4 встроенная справка для ваших собственных файлов - PullRequest
8 голосов
/ 13 мая 2011

Xcode 4 имеет очень хорошую встроенную справку / документацию, к которой вы можете получить доступ, например. нажав Alt, щелкнув идентификатор в коде, или открыв панель справки на правой боковой панели. Однако это работает только для классов и методов, предоставляемых Apple. Есть ли способ написать какие-либо комментарии к документации (например, комментарии Javadoc в Java) в вашем собственном коде, чтобы Xcode отображал их на этих панелях документации?

Ответы [ 2 ]

2 голосов
/ 13 мая 2011

http://developer.apple.com/library/mac/#documentation/DeveloperTools/Conceptual/HeaderDoc/intro/intro.html

Поддерживается Apple, поэтому должна поддерживаться. Я никогда не использовал его, может попробовать позже.

1 голос
/ 16 мая 2011

Хорошо, похоже, что на самом деле нет хороших инструментов ... есть несколько разных, но они несовершенны и их трудно настроить. Я не смог заставить Doxygen или Appledoc работать, а инструмент, упомянутый Avizzv92, в других местах называется «куча какашки», поэтому я бы не стал его пробовать ...:)

Информация, которую я нашел:

Как вы документируете свой исходный код в Xcode?

http://wangling.me/2010/07/documentation-set-generation-tool-in-xcode-is-wanted/

http://developer.apple.com/tools/creatingdocsetswithdoxygen.html

http://www.gentlebytes.com/home/appledocapp/

http://lists.apple.com/archives/xcode-users/2011/Apr/msg00238.html

...