虽然注释在对功能实现没什么作用,但却是代码中不可缺少的一部分,好的注释可增强代码的可读性、提升代码的可维护性和质量,对于 iOS 开发初学者而言, iOS 中的注释应该如何写呢?分享一篇有关 iOS 注释的编写方法的文章给大家,希望能帮助大家写出更牛叉的代码。
对于枚举类型,注释可以像如下这样写:
/** 定义的 HTTP 请求类型 /
typedef NS_ENUM(NSUInteger, ACLApiManagerRequestType) {
ACLApiManagerRequestTypeGet, /< Get 请求 */
ACLApiManagerRequestTypePost, /*< Post 请求 */
};
请自行注意注释使用的符号, 注释枚举值和枚举类型时使用的符号也有差别。
对于属性,可以像如下这样写:
@property (nonatomic, copy, readonly) NSString errorMessage; /*< 错误信息说明 */
对于方法的注释,在方法上部连续键入 /// 触发插入注释,然后删除 placeholder 的地方,填入实际的注释说明,如下:
/**
* <#Description#>
*
* @param manager <#manager description#>
* @param data <#data description#>
*
* @return <#return value description#>
*/
- (BOOL)manager:(ACLAPIBaseManager *)manager isCorrectWithParamsData:(NSDictionary *)data;
但是对于没有参数的方法,或者我们觉得方法的命名自解释已经很清楚了,则可以像如下注释:
/** API 请求除 base url 之外的 url 部分 */
- (NSString *)methodName;
以上就是 iOS 入门阶段,所需了解的一些注释相关注意事项,大家在编写 iOS 代码中,可尝试看看。
相关文章:《 iOS Realm 框架基础知识详解》 http://www.maiziedu.com/group/article/9913/
文章来源: CaryaLiu's Blog
1
mcfog 2015-12-08 16:36:24 +08:00
我最讨厌的就是这种类型的注释了
rm -rf / #删除整个根目录 assert(I am SB) //断言我是傻逼 这是觉得看代码的人不懂语法还是不懂英文? |