Как включить описание метода Doxygen в всплывающее окно автозаполнения Xcode?

Используя Xcode, я хочу, чтобы описание моего метода Doxygen было ниже опции автозаполнения, например alloc:

При записи Xcode отображает автозаполнение с комментариями из документации. Например, вы можете увидеть на изображении, когда alloc выбран из параметров, он говорит: "Возвращает новый экземпляр класса-получателя", а также ссылки на документацию.

Я смог документировать свой исходный код с Doxygen, например

/** 
 This does nothing
*/
 -(void) doNothing
{
    // This does nothing
}

и я получаю ожидаемые результаты в файле HTML, который генерирует Doxygen, но я не знаю, как заставить эти результаты появляться в качестве предложений в Xcode.

Ответ 1

Хорошие новости всем! Xcode 5 теперь имеет встроенную поддержку комментариев типа Oxygen. Итак, вы можете прокомментировать ваши методы следующим образом:

/*!
 * Provides an NSManagedObjectContext singleton appropriate for use on the main 
 * thread. If the context doesn't already exist it is created and bound to the 
 * persistent store coordinator for the application, otherwise the existing 
 * singleton contextis returned.
 * \param someParameter You can even add parameters
 * \returns The a shared NSManagedObjectContext for the application.
 */
+ (NSManagedObjectContext *)sharedContext;

Встроенная справка будет выглядеть так:

в

Быстрая справка будет выглядеть так:

в

И помощь боковой панели будет выглядеть так:

Вот удобный фрагмент кода, который вы можете добавить в библиотеку Xcode Code Snippet, чтобы упростить документацию по методу:

/**
 <#description#>
 @param <#parameter#>
 @returns <#retval#>
 @exception <#throws#>
 */

Теперь вы можете просто ввести "doxy" и poof! У вас есть шаблон doxygen.

Ответ 2

То, что я нашел лучше, чем фрагмент кода для комментариев стиля Doxygen/Javadoc, использует VVDocumenter-Xcode Plugin Это здорово! После установки вы можете просто набрать "///" над любым кодом, который хотите комментировать, и он будет захватывать параметры и возвращать, а также добавлять заполнители для завершения вашего блока комментариев.

Ответ 3

Я смог добиться того, что хотел использовать Appledocs, хотя я немного боролся с установкой и настройкой...

Откройте xCode и перейдите в xCode > Настройки > Загрузите и загрузите "Инструменты командной строки", если у вас его нет.
Откройте терминал и введите
```
git clone git://github.com/tomaz/appledoc.git
```
Когда это будет сделано, перейдите в папку appledoc, введите
```
cd appledoc
```
и установите appledoc в папку usr/local/bin с помощью этой команды:
```
sudo sh install-appledoc.sh 
```
Откройте любой проект xCode и перейдите в проводник пакетов слева и нажмите на основной файл проекта (тот, который имеет количество целей и версию sdk, приведенную ниже)
На вкладке "Настройки сборки" посмотрите кнопку "+ Добавить цель" и откройте ее
Выберите шаблон "Агрегат" (убедитесь, что вы выбрали iOS или macosx в зависимости от вашего проекта и назовите его "Документация"
Выберите "Документация" , перейдите на вкладку "Сборка фаз" и нажмите "Добавить фазу сборки" и выберите "Добавить запуск" Script.

Скопируйте и вставьте код ниже в поле Run Script:

#appledoc Xcode script
# Start constants
company="ACME";
companyID="com.ACME";
companyURL="http://ACME.com";
#target="iphoneos";
target="macosx";
outputPath="~/help";
# End constants
/usr/local/bin/appledoc \
--project-name "${PROJECT_NAME}" \
--project-company "${company}" \
--company-id "${companyID}" \
--docset-atom-filename "${company}.atom" \
--docset-feed-url "${companyURL}/${company}/%DOCSETATOMFILENAME" \
--docset-package-url "${companyURL}/${company}/%DOCSETPACKAGEFILENAME" \
--docset-fallback-url "${companyURL}/${company}" \
--output "${outputPath}" \
--publish-docset \
--docset-platform-family "${target}" \
--logformat xcode \
--keep-intermediate-files \
--no-repeat-first-par \
--no-warn-invalid-crossref \
--exit-threshold 2 \
"${PROJECT_DIR}"

В начальных константах вы можете заменить имена и т.д., также обязательно используйте правильную цель (iOS или macosx)
Наконец, перейдите в "Продукт" > "Схема" > "Редактировать схему" > "Вкладка" и добавьте цель "Документация" , убедитесь, что все флажки отмечены. Таким образом, каждый раз, когда вы создаете свой код, ваша документация обновляется.

И что это, вы можете пойти и начать документировать свой код. Обратите внимание, что несмотря на то, что обновление документации при каждом создании, предложения popover не будут обновляться до тех пор, пока вы не перезапустите Xcode. Для правильной методики документирования прочитайте эту статью