Xcode: показать документацию для моих пользовательских классов

Question

Как я могу заставить Xcode показать мою собственную документацию для пользовательских классов, методов и т. Д.?Я привык к Java и Eclipse, который показывает мне документацию для моих классов, как показано здесь:

Как я могу добиться того же в Xcode?Существуют ли специальные комментарии, которые Xcode может распознать и отобразить?

Answer 1

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

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

Answer 2

Что ж, похоже, что для классов вопрос еще не получен, поэтому я опубликую свои предложения.

Непосредственно перед строкой @interface MyClass : NSObject в файле MyClass.h, который вы используетекомментарий, как вы сделали в своем примере, но добавив несколько тегов для отображения текста.Например, код ниже:

/**
 * @class GenericCell
 * @author Average Joe
 * @date 25/11/13
 *
 * @version 1.0
 *
 * @discussion This class is used for the generic lists
 */

даст следующий вывод: вывод кода выше http://imageshack.com/a/img18/2194/kdi0.png

Answer 3

Appledoc - лучший вариант для создания документации xcode на данный момент.Doxygen великолепен, но он не генерирует наборы документов, которые очень хорошо работают для всплывающих окон, о которых вы говорите.Appledoc не идеален, но мы подошли к нему и были очень довольны результатами.

Answer 4

Также можно добавить фрагмент кода в документацию, например:

, добавив следующий код

 *  @code
 *  - (UIButton*) createButtonWithRect:(CGRect)rect
     {
        // Write your code here
     }
 * @endcode

Для получения более подробной информации одокументирование методов пользовательского класса вы можете посмотреть в моем блоге Документация по функциям в Xcode .

Answer 5

Чтобы Xcode отображал документацию для ваших классов, вы должны создать набор документации для ваших классов, используя такой инструмент, как Doxygen или HeaderDoc. После создания набора документации вы должны установить его, используя настройки документации Xcode. У Apple есть статья об использовании Doxygen, но она освещает Xcode 3, а не 4.

Использование Doxygen для создания наборов документации Xcode