在IOS（Xcode）中为函数创建类似java的文档

Question

我是IOS开发者的初学者，我正在使用Xcode。在java（android）中，我可以为下面的函数创建document：

 /**
 * Get the index object in list of object and try to catch
 * {@link IndexOutOfBoundsException}
 * 
 * @param list
 *            of object: {@link List}
 * @param index
 *            of ojbect: {@link Integer}
 * @return Object or null if {@link IndexOutOfBoundsException} occurs
 */
public static <T> T getIndexObject(List<T> list, int index) {
    T object = null;
    try {
        object = list.get(index);
    } catch (IndexOutOfBoundsException e) {
        return null;
    }
    return object;
}

当我如上所述创建document时（在Java中），每当我将鼠标悬停在函数上（在每个地方使用）时，我都会看到该函数的文档。 IOS中的Xcode怎么样？我知道Doxygen，但它只会生成HTML个文件（这不是我想要的）。我希望文档像Apple提供的每个函数的默认文档（当Ctrl + click在IOS SDK的函数上时）？我可以做吗？如何？谢谢！

Answer 1

使用AppleDoc。他们在他们的网站上有一篇文章解释了如何与Xcode集成：http://gentlebytes.com/appledoc-docs-examples-xcode/，基本上，你使用：

appledoc
--project-name appledoc
--project-company "Gentle Bytes"
--company-id com.gentlebytes
--output ~/help
--logformat xcode
.

生成文件。您还可以另外执行常规HTML。它是免费的，看起来很像Apple的文档。