Создать запись "быстрой справки" в Xcode - PullRequest
Новая
       49

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

33 голосов
/ 26 ноября 2010

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

Эквивалентом Xcode является «Быстрая справка».

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

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

Но, как видите, решения не существует.

Ответы [ 7 ]

28 голосов
/ 10 июля 2013

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

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

Перетащите это "на" фрагмент "штуки" и, как вы знаете, установите его ... enter image description here

и вот оно ...

enter image description here

9 голосов
/ 08 июля 2011

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

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

(...)

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

source: http://xcodebook.com/2011/04/providing-your-own-quick-help/

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

6 голосов
/ 09 октября 2013

Начиная с 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;

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

5 голосов
/ 11 ноября 2013

Xcode 5 теперь имеет встроенную поддержку комментариев в стиле DOxygen. Итак, вы можете прокомментировать свои методы так: 

/*!
 * 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;


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

inline help



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

quick help



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

sidebar help

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

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

doxygen code snippet

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

1 голос
/ 26 октября 2016

Для всех, кто интересуется, как это сделать в 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 должны быть правильными именами, которые вы дали своим параметрам.

0 голосов
/ 13 марта 2019

Слегка измененная версия кода Lewis 'Swift 3 с фрагментом кода: 

    /**
 <#summary#>

 <#discussion#>
 Example:
 ````
 <#example codeblock#>
 ````
 - important: <#important stuff here#>

 - version: <#version number#>

 - Parameter <#param1#> : <#description#>
 - Parameter <#param2#> : <#description#>

 - Throws: <#error description#>

 - Returns: <#return value#>

 */

Мне пришлось использовать индивидуальный синтаксис параметров, потому что в противном случае Xcode испортит форматирование вложенных параметров во фрагменте (по любой причине).

0 голосов
/ 25 апреля 2013

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

Примеры и двоичный файл для команды терминала находятся здесь:

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
...