Objective-C：制作文档

Question

我长期以来一直在使用 Visual Studio 和 C# 进行开发。现在，我正在使用 XCode 和 Objective-C 进行开发。

在 C# 上，我可以使用 ///

生成文档。 XCode 上是否有类似的机制来生成文档？以及我应该使用什么样的注释？

谢谢。

Answer 1

您是否尝试过使用Doxygen？声称支持 Objective-C。甚至还有关于 ADC 的演练。

Answer 2

还有 AppleDoc 将您的 Doxygen 注释呈现为 Xcode 可用的样式

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

正如 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/

（这作为对乔恩答案的评论会更好，但可惜我没有要点。）

Answer 5

正如所说，我最喜欢的模式:)

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