我的iPhone应用程序的评论

Question

我已经创建了我的iPhone应用程序，我必须在java中执行类似javaDoc的文档，但我没有找到谷歌的任何内容。 我认为这些评论的语法相似，但我不确定。 （/ * * /）

你能帮帮我吗？ 感谢

Answer 1

正如彼得在上面所说的那样，有DOxygen然后DOxyClean可以清理它。更多信息：http://developer.apple.com/tools/creatingdocsetswithdoxygen.html

评论可以像这样

// this is a comment above some line of code
if (foo != 0) { 
    // do something 
}

或者像这样

/*
// look ma, i'm commenting out a bunch of code

if (foo != 0) {
   // do something here
}

*/

或者像这样

// TODO: i'm marking something that will show up as a To-Do item in XCode's drop down list

我认为还有另外一个，但我不记得了。

Answer 2

您可以将//用于单行注释，或/** */用于多行注释。

使用#pragma mark进一步整理代码也是明智之举。见这里：http://cocoasamurai.blogspot.com/2006/09/tip-pragma-mark-organizing-your-source.html

还有像Doxygen这样的工具：http：//www.doxygen.nl

Answer 3

关于Doxygen的答案在撰写时就是正确的，但从那以后Appledoc已经走了很长一段路。它现在可以生成实际与弹出对话框集成的文档，这些对话框看起来非常接近官方文档。

我强烈建议人们使用Appledoc而不是Doxygen。

http://gentlebytes.com/appledoc/

PS - Doxygen仍然是一个很好的产品，可以用于其他事情。它不再是iOS项目的最佳选择。