ios - Swift 如何向函数添加编译器警告

Question

我为 viewController 编写了一个简单的扩展，我想发出警告，以便其他开发人员不要直接调用此函数。我不确定是否有一个属性可以在 swift 中实现此目的:

我的代码:

internal extension UIViewController {

    // add warning so that it can appear when another developer wants to directly access this function
    func removeFromParent() {

        self.willMove(toParent: nil)
        self.view.removeFromSuperview()
        self.removeFromParent()
    }
}

因此，当另一个开发人员尝试执行以下操作时:

let viewController = TestViewController()
viewController.removeFromParent()          

他们应该收到警告，指出您不能直接使用此功能

Answer 1

在您的函数上方添加:

@available(*, deprecated, message: "use `someOtherFunction` instead")

您还可以添加如下评论:

/// DEPRECATED: you should use `someOtherFunction` instead

因此当您的开发人员使用 Alt + Click 时就会出现