前言
遵守规范也是让代码更清晰明了,易读,易用,易维护,可以更好的适应团队开发。自己看着也是赏心悦目,何乐而不为呢。
1.基本准则
1.1编写清晰
简单明了的命名最好,不要用单词的简写,尽量用单词的全称。可以看看苹果的API格式,仿照苹果的命名,尽量用英文,而不是拼音。
1.2一致性
比如方法名的功能类型的一致性,比如获取某些数据 - (NSString *)getName,- (NSString *)getAge 中的get;或者设置数据 - (void)setName,- (void)setAge 中的set。统一方法名可以让人一看这方法就知道是干什么用的,提升开发效率。
1.3驼峰原则
- 大驼峰原则:每个单词的首字母大写(UserNameTextField)
- 小驼峰原则:第一个单词首字母小写,其余都大写(userNameTextField)
2.命名规范
2.1类命名
类的命名是采用大驼峰原则,如
UserLoginViewController
在实际开发中,一般会在类名前面加个前缀:
OYUserLoginViewController
加统一前缀方法如下图:
设置完后,每次在创建类的时候会自动添加前缀。
User → 用户
Login → 登陆
ViewController → 控制器
这个类的用途就一目了然了
其他例子:OYUserModel,OYTitleView,OYNetManager。。。
应用级别的类名(需要在其他项目中用到的类),可以不使用前缀或者使用自定义前缀
即为&#