iOS 代码规范

iOS 代码规范

1.声明及使用多参数方法时，注意使用空格，各个参数换行对齐。

-(instancetype)initWithFrame:(CGRect)frame
                  titleArray:(NSArray *)array
                sellectIndex:(long)index;

2.命名规范
2.1类名首字母大写。
2.2方法首字母小写。方法中的参数首字母小写，同时尽量让方法的命名读起来像一句话，能够传达出方法的意思，同时取值方法前不要加前缀“get”。
2.3变量名首字母小写，多个单词拼接时使用“驼峰命名法”。（例如：countTextField）
2.4全局变量添加“_”前缀，局部变量不用加。便于区分。
2.5宏定义全部字母大写。

方法命名：

- (instancetype)initWithFrame:(CGRect)frame;

3.使用Block时，内容四个空格缩进，“^”后带有参数时，参数与“{”之间有一个空格缩进。

    view.dynamicBlock = ^(long index) {

        NSLog(@"---》》%ld",index);

    };

4.尽量加标签，方便代码查看阅读。

# pragma mark----XYPieChart DateSource
- (NSUInteger)numberOfSlicesInPieChart:(XYPieChart *)pieChart;
{
    return 3;
}

5.关于注释。
5.1 属性注释。
在声明文件中声明的实例变量在上一行加注释。格式如下：

/**标题数组*/
@property (nonatomic,retain)NSArray *titleArray;
/**选中按钮底部背景*/
@property (nonatomic,retain)UIView  *backgroundView;
/**默认选中索引*/
@property (nonatomic,assign)long     selectIndex;  

5.2 方法的注释。
声明的方法，要注释方法功能，参数意义，返回值，格式如下：

/**
 *  初始化方法-2
 *
 *  @param frame frame
 *  @param array 标题数组
 *  @param index 默认选中标题索引
 *
 *  @return WJSegmentView
 */
- (instancetype)initWithFrame:(CGRect)frame
                  titleArray:(NSArray *)array
                sellectIndex:(long)index;

这个方法的注释可以使用Xcode插件——VVDocumenter 方便添加。使用时只需连按3次”/”,即可自动生成方法的注释。（附上该插件的下载地址：VVDocumenter ）.

   这只是一些最基本的代码书写规范，以后在项目中会不断总结，规范我们的代码。

————Thankyou for Reading.