【问题标题】:How to document private (non public interface) by using appleDoc?如何使用 appleDoc 记录私有(非公共接口)?
【发布时间】:2013-09-30 01:38:55
【问题描述】:

最近我学会了如何使用 appleDoc 为我的 iphone 项目做文档。

但我意识到 AppleDoc 只扫描每个类的头文件,并根据特殊的注释格式创建 docSet 和 html。

我的问题是如何让 AppleDoc 也照顾 .m 文件。因为对于像 viewController 这样的类,相当多的逻辑在 .m 扇区中,并没有暴露在头文件中。 (我问这是因为在 Xcode5 中,如果您将鼠标悬停在私有方法上并按下“选项”按钮,xcode 确实会显示包含您所做的特殊评论的悬停。这就是我猜必须有一种方法来传输这些描述/comment 到 docSet)。

有人有什么想法,请帮忙给我一些答案。

谢谢

【问题讨论】:

    标签: xcode documentation documentation-generation


    【解决方案1】:

    最后我发现脚本命令中有一行需要删除。 它将包括保存所有“私有”接口 cmets 的所有“*.m”文件。

    【讨论】:

      猜你喜欢
      • 2014-09-21
      • 1970-01-01
      • 2011-07-29
      • 2011-06-18
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2021-03-19
      • 1970-01-01
      相关资源
      最近更新 更多