iOS代码块

1.属性注释

属性注释 使用 /** 注释*/ 的文档注释格式。 这种注释相较于// 注释的优势是此属性能够在后面的引用时，在智能提示的下方显示中文注释

若是你不是在董铂然博客园看到本文请点击查看原文。

例如：

1 2 3 4

/** 回复率*/ @property(nonatomic,strong)MTPoiCompareM *replyRate; /** 回复速度*/ @property(nonatomic,strong)MTPoiCompareM *replySpeed;

在以后的调用时能够看到以下效果

而且以后在维护写完的代码时，把光标点到该属性时能够在右侧的quickhelp快速看到此属性的解释。

 

从实际的开发角度来看并非全部的属性都须要添加注释，只要是属性名能从英文直译或者简单明显的属性 不须要添加属性注释

1 2 3 4 5

@property(nonatomic,copy)NSString *name; @property(nonatomic,assign) float  avgScore; @property(nonatomic,assign) int  dealid; @property(nonatomic,assign) float  price; @property(nonatomic,assign) int  feedbackNum;

　　

①经过属性名没法快速且明显的了解该用途的属性必须添加注释,如index究竟是谁的index?可是存在下列特性的属性必须添加注释

②相似于状态的标记可能有0，1，2三种状况的要将几种状况的注释一块儿写入

③属性名的英文直译没法说清时

上面特色与下面的代码逐条对应：

1 2 3 4 5 6

/** 顶部分类的下标*/ @property(nonatomic,assign) int  index; /** 项目类型 1是团购  2是券*/ @property(nonatomic,assign) int  type; /** 本行业平均数据*/ @property(nonatomic,copy)NSString *cateValue;

　　

这里插播一下引入代码块的步骤。这里统一一属性注释的代码块为 /** <#注释#>*/  快捷键为xx

 

2.引入代码块的步骤

1.将橘色部分复制到项目中的任意一个位置。里面部分会自动缩成一个块如图

而后选中这些 拖入 右下角的代码块中。

拖入后松手会显示设置框,按要求设置

而后点击done, 这个代码块就会存在Xcode中。

使用代码块的好处就是能够在项目中敲出快捷键加回车就能立刻出现本身预置的代码而且，按tab键能够快速切换到一个个小块进行编写

 

3.方法集注释

系统有一个自带的方法集注释代码块

可是这个是不带分隔线的，若是要加分隔线 还须要在后面加上 mark - 再跟上注释，有点麻烦

使用后能够达到以下效果

现统一一下，给出代码块

#pragma mark - **************** <#输入注释#>  快捷键为mark

之因此中间用****拉长是为了不与下面的注释一块儿重叠在前面不易观看

 

全部类的数据源方法 或 代理方法的方法集前面必须加上一行方法集注释来作分隔。（代码要求将某个类的几个代理方法应该写在一块儿）

 

4.普通注释

在项目中的某个地方的逻辑可能比较复杂或者是核心思想的代码，这种地方应加上一些注释做为标注，也利于本身维护代码，利于以后别人接手代码。

例如：

现统一一下，给出代码块

// ------<#单行注释#>  快捷键为gg

 

5.优先级注释

这个重点注释能够自定义， 我给出我标注重点的注释的代码块以下，也建议你们能够统一，便于查看

// $$$$$ 快捷键为dd

通常写在一个大项目中常常须要跳过去修改的地方，用法是在这行代码后面快速敲上dd回车 变成这样

 

有时候须要找他们的时候，只须要在项目搜索里敲上就能快速定位

这里也能够设置优先级$$ 或$$$，重点或常出异常的地方都建议标注不须要吝啬。

请点击查看原文。 转载请注明出处。