Question

我一直在为Visual Studio和C＃开发很长一段时间。现在，我正在使用XCode和Objective-C进行开发。

在C＃上，我可以使用/// <summary>生成文档。 在XCode上是否有任何类似的机制来生成文档？并且我应该使用哪种评论？

谢谢。

Answer 1

您是否尝试过使用Doxygen？声称支持Objective-C。 ADC上甚至还有一个walkthrough。

Answer 2

还有AppleDoc将您的Doxygen评论呈现为Xcode可用的样式

Answer 3

Apple需要HeaderDoc代码文档。

这是一个例子。

/*!
 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

正如Jon Skeet所说，最流行的方法是Doxygen，据我所知，到目前为止，评论格式基本上可与AppleDoc互操作。

另外请务必查看Fred McCann写的评论生成器插件： 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/

（这可以更好地作为对Jon的答案的评论，但唉，我没有分数。）

Answer 5

如上所述，我最喜欢的模式：）

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

Objective-C：制作文档

5 个答案: