Создать запись "Быстрая справка" в Xcode

Как создать быстрые записи справки в Xcode для моего собственного кода? Я просто хочу, чтобы это была поддержка кодирования, что означает функцию Eclipse при кодировании Java. В eclipse вы получаете комментарий, который вы ввели выше метода при зависании метода где-то еще.

эквивалентом Xcode, по-видимому, является "Быстрая справка".

Нет ли другого способа, кроме использования Doxygen? Doxygen кажется излишним для небольшого проекта, над которым я работаю. На данный момент я точно знаю, что мне нужна только быстрая помощь, заполненная полностью, поэтому, пожалуйста, избегайте любых намеков вроде "вам нужно создать документацию для своего проекта".

Я был бы очень признателен за любую помощь, поскольку единственное, что я мог найти на эту тему, - это question.

Но, как вы можете видеть, решение не доступно.

Ответы

Ответ 1

Да... вы можете.. Вот готовый "Snippet", который вы можете перетаскивать или автозаполнять и т.д.

/** 
 * <#summary#>
 * @param <#name#> <#how you gonna get it?#>
 * @param <#name#> <#really, there more?#>
 * @return <#name#> <#what do you want!#>
 */

Перетащите это "на" фрагмент "вещь" и, как вы знаете, установите его..

и там у него есть...

Ответ 2

Я думаю, что единственный способ - создать Documentation Set для вашего кода, а затем установить его на XCode:

контекстная справка Xcode 4, которую Apple звонки "Quick Help" полностью полагаются на установленных наборов документации. Xcode 4 автоматически загружает комплекты документации (включая обновления) для Mac OS и iOS API, но вы также можно установить сторонние наборы.

(...)

Как только вы создадите свой набор документации, вы можете установить его в предпочтениях Xcodes (под Вкладка "Документация" ). Предполагая, что документ набор правильно построен и установлен, Быстрая справка должна "просто работать". из Конечно, это ограниченное использование, если только вы используете общий API с группой или широким миром.

источник: http://xcodebook.com/2011/04/providing-your-own-quick-help/

Руководство по установке документации Apple: http://developer.apple.com/library/mac/documentation/DeveloperTools/Conceptual/Documentation_Sets/

Ответ 3

Начиная с Xcode 5.0, форматирование Doxygen и HeaderDoc для переменных и методов автоматически анализируется и отображается в папке Quick Help. Подробнее об этом здесь, но здесь несколько ключевых бит:

/**
 * Add a data point to the data source.
 * (Removes the oldest data point if the data source contains kMaxDataPoints objects.)
 *
 * @param aDataPoint An instance of ABCDataPoint.
 * @return The oldest data point, if any.
 */
 - (ABCDataPoint *)addDataToDataSource:(ABCDataPoint *)aDataPoint;

отображает в Xcode как:

Что касается свойств, это так же просто, как:

/// Base64-encoded data.
@property (nonatomic, strong) NSData *data;

При нажатии этой кнопки появляется следующее сообщение:

Ответ 4

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.

Ответ 5

Для всех, кто заинтересован в том, как это сделать в Swift 3.

/**
 Makes a route

 - Parameters:
      - Parameter1 : The *x* component.
      - Parameter2 : The *y* component.
 - Throws: Error.IncorrectX if the x parameter 
    is less than zero.

 - Returns: A new integer answer which is x*y.

*/

Параметры 1 и 2 должны быть правильными именами, заданными вами параметрами.

Ответ 6

Вы можете легко создать DocSet с AppleDoc, и он генерирует QuickHelp-ссылки (опция ⌥ + щелчок мышью).

Примеры и двоичный код для команды терминала:

http://gentlebytes.com/appledoc-docs-examples-basic/

Я попробовал и использовал только базовые ключи, а новый DocSet работает с QuickHelp:

./appledoc --project-name testdocs --project-company "My Company" --company-id com.mycompany --output ~/Desktop ~/Desktop/appledoc-master