Как создать документацию для переменных переменных и методов в Xcode?

Question

Я бы хотел иметь возможность Alt-Click переменной экземпляра (или метода) как часть созданной мною программы и прочитать ее назначение.

Тот факт, что Xcode сообщает мне, что переменная класса объявлена ​​в - хорошо, но недостаточно. В этом случае я хотел бы увидеть пользовательский текст, который я напечатал, чтобы описать, что на самом деле является asset. Дополнительно было бы полезно узнать тип ивара.

Как это можно сделать? В этом случае мне интересно, что именно я имел в виду под assets

Мне особенно интересно, можно ли просмотреть эту информацию изнутри Xcode, подобно тому, как Eclipse показывает JavaDoc содержимое.

Answer 1

Вам потребуется создать набор документации для вашего проекта и установить его в Xcode. appledoc может помочь вам в этом.Это инструмент командной строки, который может генерировать документацию в стиле Apple из специально отформатированных комментариев в ваших заголовках.Вы также можете интегрировать это в свой процесс сборки с фазой сборки сценария запуска, чтобы документация всегда была актуальной.

Для небольших проектов это обычно не стоит усилий, и вы, вероятно, лучшепросто добавьте комментарии к своим заголовочным файлам и прыгайте туда с помощью Cmd-клика (Ctrl + Cmd + стрелка влево, чтобы вернуться туда, откуда вы пришли).

Answer 2

Возможно, вы захотите взглянуть на документацию Apple по Комплекты документации , а также их статью о создании наборов документов с использованием Doxygen .Последний основан на Xcode 3.x, поэтому его актуальность несколько сомнительна, но, тем не менее, было бы неплохо взглянуть.

Тем не менее, если вы решите использовать Doxygen (альтернативыкак HeaderDoc можно использовать для документации, но я не уверен, что вам доступно, что касается создания наборов документов), похоже, главное, что вы захотите добавить GENERATE_DOCSET=YES вваш Doxyfile (или как вы решите его называть).После этого вы просто выбросите результаты в ~/Library/Developer/Shared/Documentation/DocSets (согласно документации Doxygen).Я не знаю, работает ли это в Xcode 4.x - хотя стоит попробовать, и было бы приятно услышать об этом.

Примечание: большая часть этого была основана на thisответ Барри Уорком.Признанна цифра, потому что я бы не стал вдаваться в подробности, если бы не его ответ.