在XCode 7.2中自动生成Swift代码的文档模板

时间:2016-01-26 16:11:31

标签: xcode swift documentation-generation

是否可以在XCode中为给定方法自动生成文档模板?

文档模板示例:

///  
/// - parameter x: 
/// - parameter y: 
/// - parameter w: 
/// - parameter d: 
/// - returns: T

对应此方法:

func subface(x: CGFloat, y: CGFloat, w: CGFloat, d: Int) -> UIImage{
    // ...
}

2 个答案:

答案 0 :(得分:7)

通过VVDocumenter-Xcode添加 Alcatraz Package Manager

  

这是在函数定义上方写 /// 后的一个示例。

     /**
     <#Description#>

     - parameter x: <#x description#>
     - parameter y: <#y description#>
     - parameter w: <#w description#>
     - parameter d: <#d description#>

     - returns: <#return value description#>
     */
    func subface(x: CGFloat, y: CGFloat, w: CGFloat, d: Int) -> UIImage{
       /*...*/
    }
  

<# .. > 标记的部分只需点按即可修改。

答案 1 :(得分:1)

您只需要快捷方式:命令+选项+ /