OC中怎么注释自己创建的方法?

maiziedu · · 2158 次点击 · 开始浏览    置顶
这是一个创建于 的主题,其中的信息可能已经有所发展或是发生改变。
在程序开发中,我们经常需要对代码进行注释,那对于iOS初学者而言,使用objective-c语言进行应用开发的时候,如何对方法进行注释呢?今天小编为大家分享的就是这部分知识,不清楚的亲,一起来看看吧。 在iOS应用开发中,对自己创建的方法进行注释,这与编写java代码时的注释javadoc类似,可以自动形成规范性的方法说明。 我们对方法进行注释时,最需要说明的就是方法的作用、方法的参数以及方法返回的结果,所以这里也只说这三个标签,其实很简单,如下所示: /** * @brief 通过两个参数请求一个结果. * * @param valueOne 第一个参数. * @param valueTwo 第二个参数. * * @return 返回结果. */ - (NSString *)askForSomething:(NSString *)valueOne and:(NSString *)valueTwo; 声明方法时,紧挨着方法名在其上方输入上述的注释。brief表示方法的介绍,param表示参数,如果有多个就多次使用标签,这样在显示时也会显示的更好看,return表示返回的结果。其实也可以不写任何标签,那样也能显示,但是就是简单的文字,没有格式了。 现在我们调用方法,然后在调用的地方对着方法名,按住option键,也就是alt键,再点击方法名,就会弹出方法的说明,这时就可以看到我们注释的效果了: ![1.jpg](http://studygolang.qiniudn.com/151229/ec92b625aa2119f89c17a64497e18343.jpg) 这样就很清晰明了,虽然在声明方法时会做很多额外的工作,但是当代码量大了以后,这样做的效果就出来了,免得总是忘记各个方法是做什么的,参数又是什么,毕竟不能总是依靠起名嘛。 上面也说了,有简易版的注释方式,如下: /** * 通过两个参数请求一个结果.valueOne表示第一个参数.valueTwo表示第二个参数.方法会返回一个结果. */ - (NSString *)askForSomething:(NSString *)valueOne and:(NSString *)valueTwo; 效果如下: ![2.jpg](http://studygolang.qiniudn.com/151229/abb0f7d44e5a9a6e11b2f1b08423c771.jpg) 这样也能达到说明方法作用的效果,属于懒人模式,但依然比直接打两个斜杠要靠谱,不过当参数多或者说明冗长的时候就比较难以直观地理解了,看各人的选取吧。 以上就是小编在csdn上看到的比较不错的objective-c中对方法注释的两种方式,对于这两种方式还不是很了解或还没有用过的童鞋,不妨可以试试。最后,希望本文的分享,能对入门级别的开发者,在应用开发中有所帮助吧。 相关学习:iOS应用开发教程 http://www.maiziedu.com/course/ios/
2158 次点击  
加入收藏 微博
1 回复  |  直到 2018-05-19 14:52:35
暂无回复
添加一条新回复 (您需要 登录 后才能回复 没有账号 ?)
  • 请尽量让自己的回复能够对别人有帮助
  • 支持 Markdown 格式, **粗体**、~~删除线~~、`单行代码`
  • 支持 @ 本站用户;支持表情(输入 : 提示),见 Emoji cheat sheet
  • 图片支持拖拽、截图粘贴等方式上传