Swift注釋技巧
//單行注釋/* 多行注釋 *//// 標(biāo)記注釋方式1/** 標(biāo)記注釋方式2 */
注釋實例說明
示例1
/// 設(shè)置個人信息
///
/// * name 姓名
/// * address 地址
func personInfo(name:String,address:String){
}
圖例1
示例2
/// 設(shè)置個人信息
///
/// 1. name 姓名
/// 2. address 地址
func personInfo2(name:String,address:String){
}
圖例2
示例3
/// 設(shè)置個人信息
/**
name 姓名
address 地址
*/
func personInfo3(name:String,address:String)->String{
}
圖例3
示例4
/// 設(shè)置個人信息
///
/// - parameter name 姓名
/// - parameter address 地址
/// - returns: string
func personInfo4(name:String,address:String)->String{
}
圖例4
示例5(VVDocumenter推薦注釋格式)
/**
設(shè)置個人信息
- parameter name: 姓名
- parameter address: 地址
- returns: string
*/
func personInfo5(name:String,address:String)->String{
}
圖例5
標(biāo)注實例說明(-分割線)
// MARK: - 標(biāo)注
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{
}
圖例6
