我的博客原文地址
Swift注释技巧
//单行注释
/* 多行注释 */
/// 标记注释方式1
/** 标记注释方式2 */
注释实例说明
示例1
/// 设置个人信息
///
/// * name 姓名
/// * address 地址
func personInfo(name:String,address:String){
}
![图例1](https://i-blog.csdnimg.cn/blog_migrate/c3eafec0ef145270fb22aedc6fbadf3b.webp?x-image-process=image/format,png)
示例2
/// 设置个人信息
///
/// 1. name 姓名
/// 2. address 地址
func personInfo2(name:String,address:String){
}
![图例2](https://i-blog.csdnimg.cn/blog_migrate/fa4d29e1e2e9d1be42956a87a83d5c33.webp?x-image-process=image/format,png)
示例3
/// 设置个人信息
/**
name 姓名
address 地址
*/
func personInfo3(name:String,address:String)->String{
}
![图例3](https://i-blog.csdnimg.cn/blog_migrate/fa4d29e1e2e9d1be42956a87a83d5c33.webp?x-image-process=image/format,png)
示例4
/// 设置个人信息
///
/// - parameter name 姓名
/// - parameter address 地址
/// - returns: string
func personInfo4(name:String,address:String)->String{
}
![图例4](https://i-blog.csdnimg.cn/blog_migrate/e6fa0f6d503fb54f3fc29b27923a9b64.webp?x-image-process=image/format,png)
/**
设置个人信息
- parameter name: 姓名
- parameter address: 地址
- returns: string
*/
func personInfo5(name:String,address:String)->String{
}
![图例5](https://i-blog.csdnimg.cn/blog_migrate/d53d71681610497c10c113c827efa4e2.webp?x-image-process=image/format,png)
标注实例说明(-分割线)
// 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{
}
![图例6](https://i-blog.csdnimg.cn/blog_migrate/916a5e860dbaeebc3fc7993d3f1299d7.webp?x-image-process=image/format,png)