Как заставить Xcode показывать мою собственную документацию для пользовательских классов, методов и т.д.? Я привык к Java и Eclipse, который показывает мне документацию для моих классов, как показано здесь:
Как я могу добиться того же в Xcode? Существуют ли особые комментарии, которые Xcode может распознавать и отображать?
Начиная с 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;
При нажатии этой кнопки появляется следующее сообщение:
Ну, похоже, что для классов вопрос еще не ответил, поэтому я опубликую свои предложения.
Как раз перед строкой @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
Appledoc - лучший вариант для генерации документации xcode на данный момент. Doxygen замечательный, но он не генерирует документы, которые очень хорошо работают для всплывающих окон, о которых вы говорите. Appledoc не совершенен, но мы перешли к нему и были действительно довольны результатами.
Также можно добавить фрагмент кода в документации, например,
добавив следующий код
* @code
* - (UIButton*) createButtonWithRect:(CGRect)rect
{
// Write your code here
}
* @endcode
Для получения дополнительной информации о методах документирования пользовательского класса вы можете посмотреть в моем блоге Документация по функциям в Xcode.
Чтобы получить Xcode для показа документации для ваших классов, вы должны создать набор документации для своих классов с помощью инструмента, такого как Doxygen или HeaderDoc. После создания набора документации вы должны установить его с помощью настроек документации Xcode. У Apple есть статья об использовании Doxygen, но она охватывает Xcode 3, а не 4.
Использование Doxygen для создания наборов документации Xcode