命名规范、通用命名约定,指用一种通用语法来描述网络资源(如共享文件,目录或打印机)的位置。例如在Windows 操作系统,Novell NetWare以及其他可能的操作系统中,可以使用UNC而不是本地命名系统
命名原则
1.基本原则
(1)清晰。 命名应该是以清晰为主、简洁为辅。总的来讲不要使用单词的简写,除了使用非常常见的简写以外,尽量使用单词的全称。不可使用拼音、数字、容易让人看不懂易混淆的词命名。自定义API(造轮子)时,API的名称不要有歧义并且不要与苹果原生API产生冲突,让使用者一看你的API就知道是以什么方式用来做什么的。
(2)一致性。 本项目采用XFB作为类前缀,对于通知的名称也应采用XFB为前缀Notification为尾缀,宏定义应以k为前缀,对于枚举常量方法名的定义参考苹果原生API,总体来讲所有命名都应尽可能的与苹果API保持一致。
2.类命名
类名应该遵循驼峰命名原则。类名中应该包含一个或多个单词来描述这个方类(或类对象)是做什么的。
3.类别命名
类名+个人标识+拓展名
例如UIView+YPExtension
类别的方法应该使用个人标识前缀加下划线加方法名避免与项目中的其他方法产生冲突。详情参考SDWebImage的sd_setImage:方法…
4.方法命名
方法使用小驼峰法命名, 一个规范的方法读起来应该像一句完整的话,读过之后便知函数的作用。执行性的方法应该以动词开头,小写字母开头,返回性的方法应该以返回的内容开头,但之前不要加get。如果有参数,函数名应该作为第一个参数的提示信息,若有多个参数,在参数前也应该有提示信息(一般不必加and)一些经典的操作应该使用约定的动词,如initWith,insert,remove,replace,add等等。
5.变量命名
(1)变量名使用小驼峰命名规则,使变量名尽可能可以推测其用途。
(2)类的成员变量用小驼峰命名法并加上下划线开头的方式命名。
(3)一般变量命名请使用简洁明了的方式并且开头不要使用下划线。
6.常量命名
常量(预定义,枚举,局部常量等)使用小写k开头的驼峰法。
驼峰式命名法
驼峰式命名又叫小驼峰命名法。第一个单词字母小写,后面其他单词首字母大写。
ex:
int myAge;
char myName[10];
float manHeight;
帕斯卡命名法
帕斯卡命名法又叫大驼峰命名法。每个单词的第一个字母都大写。
综合各方面考虑,驼峰式命名法比较好,优势明显,事实上,目前使用驼峰式命名法的人也是越来越多