标签: appledoc

我需要为我的工作场所实施文档生成解决方案,并将其缩小到标题中提到的三个.我已经能够在这些解决方案之间进行正式比较的方式中找到很少的信息,我希望那些在上述一个或多个方面有经验的人可以权衡:

以下是我从初次传球中收集到的内容:

HeaderDoc优点:与苹果公司现有的文档一致,与制作苹果文档集的兼容性
HeaderDoc缺点:难以修改行为,项目没有积极处理,许多人已经转离它(意味着必须有一些不足之处,尽管我无法量化它).

Doxygen Pros:活跃支持社区b/c广泛使用基础,非常可定制,大多数输出​​类型(如乳胶等)
Doxygen缺点:工作使其外观/行为与apple docs一致,与apple docsets的兼容性并不那么简单

AppleDoc专业人士:看起来与苹果现有的文档一致,与制作苹果文档集的兼容性,
AppleDoc缺点:有关typedef,枚举和函数文档的问题,正在积极开发中

这听起来准确吗？我们理想的解决方案将:

• 苹果Objective-c类参考的一致外观
• 能够选项单击以从Xcode中提取文档引用,然后链接到doc(就像苹果的类)
• 智能处理类别,扩展等(甚至是苹果类的自定义类别)
• 能够创建我们自己的参考页面(比如这个页面:Loading ...可以包含图像,并且可以无缝地链接生成的类引用,就像apple的UIViewController类引用链接到链接页面一样.
• 易于运行的命令行命令,可以集成到构建脚本中
• 优雅地处理非常大的代码库

根据以上所有信息,上述任何一种解决方案明显优于其他解决方案吗？任何建议或信息,将非常感激.

我正在阅读有关如何在此处生成类似Apple的HTML文档的文章.我的问题是命令行的用途.我们如何组合命令行和appledoc xcode项目来生成HTML.

我希望能够将Alt-Click一个实例变量(或方法)作为我创建的程序的一部分,并阅读它的目的.

事实上Xcode告诉我类变量被声明为 - 很好但不够.在这种情况下,我希望看到我输入的自定义文本来描述asset真正的内容.另外,ivar的类型也很有用.

如何才能做到这一点？在这种情况下,我想知道究竟是什么意思assets

我特别想知道这些信息是否可以从内部查看Xcode,类似于Eclipse节目JavaDoc内容.

我怎样才能显示内嵌代码块像this在Appledoc评论？

反引号只是在Xcode快速帮助面板中作为反引号读取.

我真的很想以NSStringFromClass某种方式编纂.

我目前正在构建用Objective-C编写的iOS SDK.现在我已经测试并准备好了SDK,想要将Swift和Objective-C结合起来添加文档.我一直在研究Doc生成器工具

一个.Doxygen的

湾 AppleDoc

C.爵士

d.Apple的HeaderDoc.

我想在Objective-c头文件中使用注释,并为Objective C和Swift生成组合帮助,类似于Apple最近的做法.我的问题是如何从Objective-C头文件生成Swift和Objective-C的文档？

以下是基于我的研究的一些链接:

• https://github.com/realm/jazzy/issues/353
• https://github.com/jpsim/SourceKitten/pull/95

谢谢,

内存.

请参考这里的苹果文档:

我正在使用Appledoc生成评论.在基本的变体我得到这样的页面http://sdk.quickblox.com/ios/

我希望得到类似这样的内容http://qblx.co/OrAHzE - 按类别分组的类.

我读了这篇文档http://gentlebytes.com/appledoc-docs-comments/,没有找到任何关于此的信息.有人做过这样的事吗？坦克