Как создать документацию для переменных переменных и методов в Xcode?
Я хотел бы иметь возможность Alt-Click переменная экземпляра (или метод) как часть программы, которую я создал, и прочитайте, для чего она предназначена.
Тот факт, что XCode сообщает мне, что переменная класса объявлена в - хорошо, но недостаточно. В этом случае я хотел бы увидеть пользовательский текст, который я напечатал, чтобы описать, что asset на самом деле. Кроме того, тип ивара также было бы полезно узнать.
Как это может быть сделано? В этом случае мне интересно, что именно я имел в виду под assets
Мне особенно интересно, если эту информацию можно посмотреть изнутри Xcodeаналогично тому, как Eclipse шоу JavaDoc содержание.
2 ответа
Вам нужно будет создать набор документации для вашего проекта и установить его в Xcode. Appledoc может помочь вам в этом. Это инструмент командной строки, который может генерировать документацию в стиле Apple из специально отформатированных комментариев в ваших заголовках. Вы также можете интегрировать это в процесс сборки на этапе сборки сценария запуска, чтобы документация всегда была актуальной.
Для небольших проектов это обычно не стоит усилий, и вам, вероятно, лучше просто добавить комментарии к своим заголовочным файлам и перейти туда с помощью Cmd-клика (Ctrl+Cmd+ стрелка влево, чтобы вернуться туда, откуда вы пришли).
Возможно, вы захотите взглянуть на документацию Apple по комплектам документации, а также на их статью о создании наборов документов с помощью Doxygen. Последний основан на Xcode 3.x, так что его актуальность несколько сомнительна, но, тем не менее, было бы неплохо взглянуть.
Тем не менее, если вы решите использовать Doxygen (альтернативы, такие как HeaderDoc, могут быть использованы для документации, но я не уверен, что вам доступно в том, что касается создания наборов документов), похоже, главное, что вы захотите бросать GENERATE_DOCSET=YES в ваш докси-файл (или как вы решите его назвать). После этого вы просто выбросите результаты в ~/Library/Developer/Shared/Documentation/DocSets (согласно документации Doxygen). Я не знаю, работает ли это в Xcode 4.x - хотя стоит попробовать, и было бы приятно услышать об этом.
Примечание: большая часть этого была основана на этом ответе Барри Уорка. Признаться за цифру, так как я бы не стал заниматься этим, если бы не его ответ.