swift framework的注释

参考链接：http://swifter.tips/documentation/

Swift 采用了一套新的文档注释方法，对于一个简单的方法，我们的文档注释看起来应该是这样的：

/**
A demo method

- parameter input: An Int number

- returns: The string represents the input number
*/
func method(input: Int) -> String {
    return String(input)
}

在文档注释的块中 (在这里是被 /*…/ 包围的注释)，我们需要使用 - parameter 紧接输入参数名的形式来表达对输入参数的说明。如果有多个参数的情况下，我们会需要对应着写多组 - parameter 语句。如果返回值不是 Void 的话，我们还需要写 - returns: 来对返回进行说明。

对于像属性这样的简单的声明，我们直接使用 /// 就可以了：

///Homecare颜色定义
public class HCColor : UIColor {
    ///APP 主色调，用于导航、按钮及重要的文字提醒等 浅蓝
    public class func HCMainColor(alpha: CGFloat = default) -> UIColor
    
    ....
}