Объектив C Комментарии метода

Каким образом можно комментировать методы для Objective C? Например, в .Net я бы добавил комментарий xml, например:

/// <summary>
/// Summary of method
/// </summary>
/// <param name="FileName">The document original filename.</param>  
/// <returns>Decoded filename</returns>

Есть ли эквивалент для Objective C?

Ответы

Ответ 1

Не забывайте о знаках прагмы для блокировки вашего кода. Это помогает XCode разделять методы в раскрывающемся списке. Он также визуально разбивает ваш исходный файл и облегчает его чтение.

Вот как я блокирую разделы кода:

///////////////////////////////////////////////////////////////////////////
#pragma mark -
#pragma mark View Lifecycle
#pragma mark -
///////////////////////////////////////////////////////////////////////////

- (void) functionsHere

В конечном итоге это делается в XCode:

enter image description here

Ответ 2

Существуют файлы заголовков appledoc, которые можно использовать, те же, что использует Apple.

Для отдельных методов лучшим руководством является использование очень описательных имен, это довольно легко в Objective-C с параметрами, перемежаемыми в имени метода. Это обычно устраняет необходимость в комментариях отдельных параметров.

Как и в любом языке, описательные имена методов и короткие одноцелевые методы воспроизводят длинные комментарии, которые плохо изменяются с изменением кода.

Ответ 3

Стиль комментирования, о котором вы упоминаете, по-видимому, относится к тому, что генератор документации подбирает для вас документацию.

Таким образом, эквивалентный стиль комментариев на objective-c будет зависеть от выбранного генератора документации. Насколько мне известно, по умолчанию не существует.

Вы можете использовать что-то вроде Doxygen или appledoc, если вы хотите что-то, что дает результаты, похожие на собственную документацию разработчика Apple. Эта страница детализирует формат комментариев. Пример: GBComment.h

Ответ 4

Как я это делаю,

//-----------------------------------------------------------------------------------------------------//
#pragma mark - Table view Datasource -
//-----------------------------------------------------------------------------------------------------//

Ответ 5

/**
*   @brief  set refresh datetime
*
*   @param  value of refresh datetime
*
*   @return
*
*/

это отображается при быстрой помощи

считает

Ответ 6

Вы использовали бы

//for a single line comment
/*Use this for the start of a block comment
*/Use this for the end of a comment
   /*text text text;
   code code;
   code code code;//comment
   code;//comment
   code;*/