@(代码写作规范)
[TOC]
一、文件名规范
命名格式
驼峰写法
通用格式：
绝对不允许用拼音命名~！！！
所有被普遍继承的类 以 `项目名`+`Base`+`类别` 命名
如：TGYBaseViewController
若无特别说明，文件名都以 `项目名称`+`功能描述`+`类的类型` 命名
命名规则:
Controller：
以 `项目名` + `功能描述` + `Controller类型`命名
如 TGYLoginViewController
如 整个名称过长，可以缩写成：
`项目名` + `功能描述` + `Controller类型缩写`
如 TGYDetailOfTheSelectedDayVC
模型：
以 `项目名` + `功能描述` + `Model` 命名
如 TGYNoticeModel
分类：
1.如该分类功能可以普遍应用
以 `base类` + `TG` 命名
如 NSString+TG (此类分类可以应用于多个项目)
2.如该分类功能专门作用于单一功能则
以 `base类` + `功能作用` 命名
如：NSString+Emotion
自定义类
以 `TG` + `功能描述` + `类名` 命名
单例
以 `功能描述`+ `Manager` 命名
ps：如果是项目用户单例，则在前面加上`项目名称`
处理逻辑的工具类
以 `功能描述`+ `Helper` 命名
如：TGRequestsHelper
二、属性,变量规范
变量
私有变量 变量名前 + `_` 下划线
如 BOOL _firstResponse
常量
全大写，单词用分隔符`_` 分隔
如 RE_BASE_URL
属性，控件等
首字母小写，名称后面加上类 方便分辨
如 :
/**
* line
*/
@property (nonatomic, strong) CALayer *lineLayer;
/**
* 已阅按钮
*/
@property (nonatomic, strong) UIButton *readBtn;
每个属性前面必须加上简单的注释
三、方法规范
私有的方法,不允许外界访问的方法，在方法名前增加 标识符 `_`
如：
-(void)_layout{
}
公有方法不变，格式沿用驼峰，首字母小写
方法前需加上注释：
格式如下:
/**
* @brief 产生随机数
* @param style 看上面的enum枚举
* @param space 文字跟图片的间距
*
* @return nil
*/
四、写作总体规范
/*注释*/ 属性，变量，方法的声明必须加上注释
1.无需空行的地方不能空行
2.属性,变量较少时无需空行,较多时,按功能模块分类适当空一行
3.方法与方法间空一行，方法顺序按照功能划分，并在每个功能的第一个方法上添加上：
#pragma mark -tableViewDelegate
4.代码写法尽量简洁易懂，自己优化
5.每一个.m文件尽量不要超过1K行代码，超过请自行优化