I am Java developer and would like to know how I can get the equivalent of a JavaDoc in Xcode when CodeSense is doing its auto-complete? If I hit the ESC button I can get a list of methods etc. but it does not show me the descriptions of what the methods do.
A:
It's not quite the same, but the close equivalent is Quick Help, accessible from the Help Menu. It's a floating palette that dynamically shows a quick documentation for the method or class at your cursor position.
Matt B.
2010-01-28 21:21:36
…and which is also accessible by Option-double-clicking a keyword in your code.
Rob Keniger
2010-01-29 03:58:05
is there no way to automatically read documentation on the fly as the auto-sense pops up?
Sheehan Alam
2010-01-29 20:13:41
I don't believe there is. To be honest, I find the method names themselves so descriptive that I don't find it necessary. Even the longer abstract in quick help is often completely redundant with the method name. E.g. NSString's `drawInRect:withAttributes:` has this in Quick Help: **Abstract:** Draws the receiver with the font and other display characteristics of the given attributes, within the specified rectangle in the currently focused NSView.
Matt B.
2010-01-29 21:29:30