Цель C Метод Комментарии

Question

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

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

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

Answer 1

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

Вот как я блокирую участки кода:

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

- (void) functionsHere

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

Answer 2

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

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

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

Answer 3

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

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

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

Answer 4

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

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

Answer 5

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

это отображается в справке

думает

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