backmeupplz
@backmeupplz

Как правильно задокументировать метод в Objective C?

Хочу задокументировать свой код так, как это сделано в исходниках языка; чтобы при нажатии Option и клике на методе, можно было увидеть нечто следующее:



Попробовал использовать Javadoc и подобным образом задокументировал метод:

/**
 Method get something
 @param string some parameter
 @return returns something
 */
+ (NSString *)getOpenOrdersCount;

А получается вот так:



Можете привести пример, как документировать код, чтобы при нажатии option и клике было видно окошко с полными данными (не только declared)?
  • Вопрос задан
  • 3874 просмотра
Решения вопроса 1
eltiren
@eltiren
Такая возможность есть в новом Xcode 5. Для Xcode 4 — appledoc и doxygen.



В нем вообще много изменений — смотрите What’s New in Xcode 5 в списке видео с WWDC 2013
Ответ написан
Комментировать
Пригласить эксперта
Ответы на вопрос 1
@Chupik
Как подсказывает Stackoverflow, Objective C не имеет встроенной возможности документирования. Как один из вариантов, на сайте разработчиков Apple показана работа с утилитой Doxygen, которая поможет составить удобную документацию.
Ответ написан
Комментировать
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы