1

我是第一次使用 DocC,在阅读了您的文档后,有 4 件事我不知道该怎么做,您能帮帮我吗?

如何标记公共方法以告诉 DocC 我不想为特定方法生成文档?例如,我有一个CaruselView,它是 的子类UIView。这个子类正在覆盖方法layoutSubviews。DocC 正在生成空文档。不大好。在使用 Jazz(另一个文档系统)时,我可以使用:

/// :nodoc:

但是,DocC 中的等价物是什么?

UIView我添加到, UIColor, ...的所有公共方法UILabel使用扩展名和文件,例如"UIView+Extensions.swift,在我按下Generate DocumentationXcode 后,它们不会出现在生成的文档中。这是 DocC 限制还是错误?我的意思是,我看到了类、枚举、结构的部分......但没有关于 UIKit 类/结构的扩展。

除此之外,如果我的结构或类之一引用这些方法之一(在扩展文件中),我不知道创建链接的语法。例如,这不起作用:

/**
 An enum for use when using `UIView/applyElevation(_:)`
 */

我该怎么做?由于我之前的问题,我想我无法链接不存在的东西。

最后一个问题,使用双引号我们可以在我们的包/框架中引用符号。这工作正常。但是我们如何链接来自UIKit其他 Apple 框架或其他 Apple 框架的符号呢?例如:

/// A `UIView` consisting of a combination of ``CarouselView``, ``FlagLabel``
/// and ``IconButton`` intended for displaying product information.

如果我使用

``UIView``

这没用。我应该使用什么格式?

非常感谢您的建议。

4

0 回答 0