Как добавить подсказки по использованию для наших пользовательских методов и свойств в Xcode?

Code completion with usage hints at the bottom

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

1 ответов


вы делаете это, добавляя специально отформатированные комментарии над объявлением в заголовке. е.х:

/**
 *  This is my awesome new property!!!
 */
@property (strong, nonatomic) NSObject *someProperty;


/**
 *  An even cooler description!
 *
 *  @param  string  some string
 *  @param  arr some array
 */
- (void)myAwesomeMethodWithAweomseParamOfType:(NSString *)string andOtherParam:(NSArray *)arr;

затем, когда я перейду к моему файлу реализации и начну печатать...

enter image description hereenter image description here

однако, если вы не хотите утруждать себя запоминанием всех особенностей форматирования этих комментариев, скачайте VVDocumneter из github. Это плагин Xcode, который автоматически добавит эти комментарии. Все, что тебе нужно сделать, это перейдите к строке над объявлением, и нажмите ///.