码迷,mamicode.com
首页 > 编程语言 > 详细

Swift代码注释分析 xcode提示 提高可读性

时间:2016-06-30 23:10:28      阅读:194      评论:0      收藏:0      [点我收藏+]

标签:

详细地址:http://www.code4app.com/forum.php?mod=viewthread&tid=9133#lastpost

 

 

昨天看自己的代码的时候发现自己的注释实在是太乱了,也看不大清楚

之前用oc的时候也用过简单的注释,于是乎就去找了点资料看了下 ,swift下几个注释关键字都变了

主要是

[Objective-C] 查看源文件 复制代码
1
2
3
4
5
6
7
8
9
`//`
 
`///`
 
`//MARK: - `
 
`//TODO: -`
 
`//FIXME: - `



第一个`//`肯定是大家最熟悉不过的,简单的一行注释,快捷键`cmd+/  ` 这个就不多做介绍了
下面要介绍的是`///` 这个可以显示出函数功能,在代码提示中可以出现
简单用法:

[Objective-C] 查看源文件 复制代码
1
2
3
4
  ///获得cell大小和contenview的大小
func getPicCollectionCellSize() -> CGSize {
   return xxxxxx   
}



这样你在调用时会有提示
<ignore_js_op>技术分享 
继续加强版: 带参数和返回值

[Objective-C] 查看源文件 复制代码
1
2
3
4
5
6
7
8
///获得cell大小和contenview的大小
    ///
    ///  - parameter 参数1: 说明
    ///  - parameter 参数2: 测试
    ///  - returns: 返回size
        func getPicCollectionCellSize(tmp : Int) -> CGSize {
           return xxxxxx   
        }



这样你在按option键就的函数提示就是这样
<ignore_js_op>技术分享 


接下来

`//MARK: - `

[Objective-C] 查看源文件 复制代码
1
2
3
4
5
//MARK: - 处理collcetionViewDataSource
   func collectionView(collectionView: UICollectionView, numberOfItemsInSection section: Int) -> Int{
       print(picUrl?.count)
       return picUrl!.count
   }



<ignore_js_op>技术分享 


`//TODO: - `  简单的介绍

<ignore_js_op>技术分享 


`//FIXME: - `  可以提示bug

<ignore_js_op>技术分享 

基本掌握这些,你的代码就可读性就高很多了.

Swift代码注释分析 xcode提示 提高可读性

标签:

原文地址:http://www.cnblogs.com/Code4/p/5631312.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!