问题标签 [appledoc]

我希望能够将Alt-Click实例变量（或方法）作为我创建的程序的一部分并阅读它的目的。

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

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

我特别想知道是否可以从内部查看此信息Xcode，类似于如何Eclipse显示JavaDoc内容。

我在 Xcode 4（Xcode > 行为 > 编辑行为 > +）中创建了一个自定义行为，以启动一个 shell 脚本（配置为可执行）。我可以使用菜单或我的自定义快捷方式调用该行为（控制台按指定显示），但脚本没有执行（控制台中没有输出）。该脚本已经在终端中进行了测试，并且运行良好！而且我还创建了一个带有简单回声的虚拟脚本，结果是一样的......为什么？我该如何调试呢？

编辑：

解决问题后，我意识到我的想法，如果您有兴趣阅读我的帖子： 使用 AppleDoc、Xcode 自定义行为和 AppleScript 使用简单的快捷方式生成漂亮的代码文档！

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

在浪费了一些时间弄清楚出了什么问题之后，我终于不得不寻求帮助。我想使用来自 Gentle Bytes 的 appledocs。我遵循了快速安装指南的每一步，但我无法编译该项目。

这是我所做的： 1. 从 git://github.com/tomaz/appledoc.git 克隆它 2. 将模板安装到 ~/Library/Application Support/appledoc 3. 尝试编译项目

每次我尝试编译时，都会收到以下错误： 错误：AppledocException：至少需要一个目录或文件名路径，请使用“appledoc --help”

我现在该怎么办？

我需要为我的工作场所实施文档生成解决方案，并将其范围缩小到标题中提到的三个。在这些解决方案之间进行形式化比较的方式中，我能够找到的信息非常少，我希望你们中具有上述一项或多项经验的人能够参与进来：

以下是我从最初的通行证中收集到的信息：

HeaderDoc 优点：与苹果现有的文档一致，与制作苹果文档集的兼容性
HeaderDoc 缺点：难以修改行为，项目没有积极开展，许多人已经放弃它（意味着一定有缺陷，虽然我无法量化它）。

Doxygen 优点：积极支持广泛使用基础的社区 b/c，非常可定制，大多数输出​​类型（如乳胶等）
Doxygen 缺点：需要努力使其外观/行为与苹果文档一致，与苹果文档集的兼容性并不那么简单

AppleDoc 优点：看起来与苹果现有的文档一致，与制作苹果文档集的兼容性，
AppleDoc 缺点：类型定义、枚举和函数的文档存在问题，正在积极开发中

这听起来准确吗？我们所需的解决方案将具有：

• 与苹果objective-c 类参考一致的外观
• 能够通过选项单击从 Xcode 中提取文档参考，然后链接到文档（就像苹果的类一样）
• 智能处理类别、扩展等（甚至是苹果类的自定义类别）
• 能够创建我们自己的参考页面（比如这个页面：加载中……可以包含图像，并且可以从生成的类引用无缝链接，比如苹果的 UIViewController 类引用如何链接到链接页面。
• 易于运行的命令行命令，可以集成到构建脚本中
• 优雅地处理非常大的代码库

基于以上所有信息，上述任何解决方案是否明显优于其他解决方案？任何要添加的建议或信息将不胜感激。

目前，我们的团队正在使用 SVN 存储库来管理我们在服务器 A 上的代码，并且对该存储库的更改通过 Jenkins 触发构建，以便在服务器 B 上启动（因此服务器 B 有一个工作空间来镜像服务器 A 上的存储库）。现在，我们希望使用像 doxygen 或 appledoc 这样的文档生成器，但我不确定生成的文档应该放在哪里。

例如，Jenkins 有一个 doxygen 插件；但由于 jenkins 构建命令只能访问当前工作区，这意味着 jenkins 插件要访问的 doxyfile 必须存在于工作区中，因此处于源代码控制之下（来自存储库）。这很好，但是生成的 doxygen 输出不应该真正受到源代码控制，那么这是否意味着 doxyfile 应该指定要在工作区之外的服务器 B 上某处创建的输出？

此外，总体目标是生成可通过我们各个团队成员的 Xcode 无缝使用的停靠集；但这似乎意味着生成的文档/生成文件等确实需要以某种方式成为工作区的一部分（以便各个团队成员可以通过 SVN 更新接收结果）......但这看起来很笨重，我甚至不确定在不是来自 SVN 存储库的工作空间中创建文件夹/文件是否符合规定（因为工作空间是镜像）。

基本上，我正在寻找一种通过 Jenkins 生成文档/文档集作为构建过程的一部分的方法，并让我们的各个团队成员对生成的文档具有 Xcode 选项单击优点（理想情况下不需要任何手动步骤）。这可能吗？

谢谢你。

我正在使用 appledoc 生成文档集。一切都很好，除了每次我重建它（使用我的 plist 并运行 shell 脚本）我必须重新启动 xcode 以查看更改。

有没有办法强制 xcode 重新加载 docset ？

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

我想得到这样的东西http://qblx.co/OrAHzE - 按类别分组的类。

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

所以我下载了最新的 3.1 Facebook iOS sdk，并在脚本下找到了我运行的 build_documentation.sh。它完成并生成了一个 com.facebook.Facebook-SDK-3_0-for-iOS.docset 文件。我试图让它与 XCode 很好地集成。我知道苹果文档可以创建显示在快速帮助面板中的文档。我自己的自定义文档效果很好。

有谁知道我必须做些什么才能获得与 Facebook 相同的文档集成？

编辑：我尝试根据此处的说明将文档集添加到相应的文件夹 并重新启动 Xcode，但它不起作用

所以我有一个构建脚本，它在 xcode 中构建我的库后运行，它生成 appledoc 文档并将其安装到 XCode 中。

令人讨厌的是，这会将所有 HTML 等放入我的用户主文件夹的（隐藏）库文件夹中的一个不起眼的文件夹中。

真正棒的是能够从这些文档集中复制 HTML 并将它们放入项目目录中的文件夹中。然后可以在需要发布时将其复制到库的压缩存档中。

如果是手动执行的情况（查看appledoc的帮助页面，它似乎不能开箱即用）那么我可以这样做，但是有没有办法从appledoc获取最终目录路径？我能看到的唯一方法是拆开输出文件并在其中找到路径。

谢谢你的帮助！:)

汤姆