【问题标题】:Xcode: show documentation for my custom classesXcode:显示我的自定义类的文档
【发布时间】:2011-08-05 15:02:07
【问题描述】:

如何强制 Xcode 显示我自己的自定义类、方法等文档?我习惯了 Java 和 Eclipse,它向我展示了我的类的文档,如下所示:

如何在 Xcode 中实现相同的功能?有没有 Xcode 可以识别和显示的特殊 cmets?

【问题讨论】:

  • 好问题!我其实不知道;我通常只需命令单击类(或函数、变量或...)名称即可跳转到其定义。不理想,但您可以使用 command-control-left 箭头直接跳回到原来的位置,因此几乎一样快。
  • @Ryan:感谢您的建议。不完美,但它是合理的选择。

标签: xcode


【解决方案1】:

从 Xcode 5.0 开始,变量和方法的 Doxygen 和 HeaderDoc 格式会自动解析并呈现在快速帮助弹出窗口中。有关它的更多信息here,但这里有一些关键位:

/**
 * Add a data point to the data source.
 * (Removes the oldest data point if the data source contains kMaxDataPoints objects.)
 *
 * @param aDataPoint An instance of ABCDataPoint.
 * @return The oldest data point, if any.
 */
 - (ABCDataPoint *)addDataToDataSource:(ABCDataPoint *)aDataPoint;

在 Xcode 中呈现为:

至于属性,很简单:

/// Base64-encoded data.
@property (nonatomic, strong) NSData *data;

当点击选项时,会出现这个可爱的弹出框:

【讨论】:

  • 非常好!感谢分享。
  • Here is the full syntax guide. 似乎并非全部都受支持(例如,@link 已损坏)。
  • 如何在描述中指定@。如果我使用 user@abc.com。 Xcode 只显示 user.com。
  • @Nil 这在 Xcode 7.1 中的 Swift 2.1 代码中对我来说没问题。截图:cloudup.com/cvtpstuUsUW
  • @Nil 否则,尝试反斜杠转义 @ 符号。
【解决方案2】:

好吧,看来课程的问题还没有得到回答,所以我会发布我的建议。

就在 MyClass.h 文件中的 @interface MyClass : NSObject 行之前,您可以像在示例中一样使用注释,但添加一些标签来显示文本。例如下面的代码:

/**
 * @class GenericCell
 * @author Average Joe
 * @date 25/11/13
 *
 * @version 1.0
 *
 * @discussion This class is used for the generic lists
 */

将产生以下输出: the output of the code above http://imageshack.com/a/img18/2194/kdi0.png

【讨论】:

  • ImageShack 删除了前一段时间没有高级帐户的用户的所有图像:(
【解决方案3】:

Appledoc 是目前生成 xcode 文档的最佳选择。 Doxygen 很棒,但它不会生成对您正在谈论的弹出窗口非常有效的文档集。 Appledoc 并不完美,但我们转向了它并且对结果非常满意。

【讨论】:

  • 我尝试了appledoc提供的示例项目。我能够添加文档,但它不显示参数或返回值描述,如您的示例中所示。你能告诉我哪里出错了吗?
【解决方案4】:

也可以在文档中添加一些代码sn-p,如下所示

通过添加以下代码

 *  @code
 *  - (UIButton*) createButtonWithRect:(CGRect)rect
     {
        // Write your code here
     }
 * @endcode

有关自定义类的文档方法的更多详细信息,您可以查看我的博客Function Documentation in Xcode。

【讨论】:

    【解决方案5】:

    要让 Xcode 显示您的类的文档,您必须使用 Doxygen 或 HeaderDoc 等工具为您的类创建一个文档集。创建文档集后,您必须使用 Xcode 的文档首选项安装它。 Apple 有一篇关于使用 Doxygen 的文章,但它涵盖了 Xcode 3,而不是 4。

    Using Doxygen to Create Xcode Documentation Sets

    【讨论】:

    • 我仍然希望这不是唯一的解决方案。毕竟,XCode 已经解析了我的源代码,也许还有一些更简单的方法。谢谢你的回答。
    • Xcode 的快速帮助使用您安装的文档集来显示其内容。除非您为类创建和安装文档集,否则所有快速帮助显示都是指向您声明类、方法或数据成员的头文件的链接。查看 Xcode 的符号导航器。它显示了你的类的方法和成员。选择视图 > 导航器 > 显示符号导航器以打开符号导航器。
    猜你喜欢
    • 1970-01-01
    • 2015-12-12
    • 2018-06-26
    • 2016-11-02
    • 1970-01-01
    • 2015-03-14
    • 2015-06-24
    • 1970-01-01
    • 2017-06-10
    相关资源
    最近更新 更多