xcode - 在 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 + clickIOS 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 的文档。