Swift注释技巧
//单行注释
/* 多行注释 */
/// 标记注释方式1
/** 标记注释方式2 */
注释实例说明
示例1
/// 设置个人信息 /// /// name 姓名 /// address 地址 func personInfo(name:String,address:String){
}
示例2
/// 设置个人信息 /// /// 1. name 姓名 /// 2. address 地址 func personInfo2(name:String,address:String){
}
示例3
/// 设置个人信息 /* name 姓名 address 地址 / func personInfo3(name:String,address:String)->String{
}
示例4
/// 设置个人信息 /// /// - parameter name 姓名 /// - parameter address 地址 /// - returns: string func personInfo4(name:String,address:String)->String{
}
示例5(VVDocumenter推荐注释格式)
/** 设置个人信息
- parameter name: 姓名
- parameter address: 地址
- returns: string
*/
func personInfo5(name:String,address:String)->String{
}
标注实例说明(-分割线)
// MARK: - 标注 func personInfo6(name:String,address:String)->String{
}
TODO实例说明
// TODO:未完成 func personInfo7(name:String,address:String)->String{
}
FIXME实例说明
// FIXME:bug2014 func personInfo7(name:String,address:String)->String{
}