iOS代码文档化,比注释更高级!

一份好的代码,却少不了注释,但是有没有比写注释更好的办法呢?
下面让我们来看看代码文档化。
究竟什么是文档化,是不是听起来很高大上呢!看完下面的一张图你就会明白!
这里写图片描述
当我们按住option键点击某个方法的时候,就会弹出相关说明,这个就是文档化。
当然也可以是某个属性的说明
这里写图片描述

接下来简单介绍该如何操作
1.属性描述,我们声明一个手机号的属性,并在它的上方加入文档注释

//! 这是一个手机号
@property NSString *mobile;

大功告成!是不是很简单呢!下面再来一个复杂一点的方法说明

/*!
@brief 这是一个把字符串转换成浮点类型的方法.
@param  fromString 要转换的字符串
@return 转换过后的浮点类型
@code
float f = [self toFloat:@"1.0"];
@endcode
@remark 注意,这是一个减号方法
*/

- (float)toFloat:(NSString *)fromString;

基本使用就这么多了,值得一提的是@brief可以省略,通常情况下我更喜欢简写,比如

//! 这是一个把字符串转换成浮点类型的方法. @param fromString 要转换的字符串
- (float)toFloat:(NSString *)fromString;

这里写图片描述

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值