Цель-C: создание документации

Question

Я давно разрабатываю для Visual Studio и C #. Сейчас я работаю с XCode и Objective-C.

На C # я могу использовать /// <summary> для генерации документации. Есть ли какой-нибудь механизм, подобный этому, в XCode для генерации документации? И какие комментарии я должен использовать?

Спасибо.

Answer 1

Вы пробовали использовать Doxygen ? Это утверждает, что поддерживает Objective-C. На АЦП есть даже прохождение .

Answer 2

Как сказал Джон Скит, самый популярный метод - это Doxygen, и, насколько я могу судить, форматирование комментариев в основном совместимо с AppleDoc.

Также не забудьте проверить плагин генератора комментариев, который написал Фред МакКанн: http://www.duckrowing.com/2011/05/14/using-the-doxygen-helper-in-xcode-4/

У него также есть отличный пост для написания комментариев к Doxygen: http://www.duckrowing.com/2010/03/18/documenting-objective-c-with-doxygen-part-i/

(Это было бы лучше в качестве комментария к ответу Джона, но, увы, у меня нет очков.)

Answer 3

Вам нужно HeaderDoc , которое Apple рекомендует для документации кода.

Вот пример.

/*!
 This is a method.

 @param    param1    This is first parameter.

 @result
 This method returns nothing.

 @discussion
 This is an example.


 */
- (void)someMethodWithParam1:(NSInteger)param1
{
}

Руководство: http://developer.apple.com/library/mac/#documentation/DeveloperTools/Conceptual/HeaderDoc/intro/intro.html

Answer 4

Существует также AppleDoc , чтобы преобразовать ваши комментарии Doxygen в стиль, используемый Xcode

Answer 5

Как я уже сказал, моя любимая модель:)

   ///////////////////////////////////////////////////////////////////////
   /// \brief setX
   /// \param x offset of the image.
   /// \return a new image as an QImage.
   /////////////////////////////////////////////////////////////////////////
    QImage  setX(int x);