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