技术源于生活,服务生活 Terry 随笔

iOS开发命名规范

2015-09-15
Terry
iOS

iOS开发命名规范,个人代码库,第二次修改

  1. 公共代码库命名为: JxdCommon
  2. 主要命名方式为驼峰命名法
  3. 所有类型命名以 Jxd 为开头. 如: JxdHttp, JxdMessageHook
  4. 根据不同类型添加不同的后缀:
    • Block分块以 Block 为后缀; 如: typedef void(^JxdEmptyBlock)();
    • 管理多个元素为主的类以 Manager 为后缀; 如 JxdCacheManager, JxdNotifyManager
    • 管理类中的自定义类一般以 Info 为结尾; 如 JxdTextPagingInfo
    • NS_ENUM, NS_OPTIONS一般根据含义添加如Style, Type, mode 等后缀, 如 JxdTimeUnitType
    • 具有见名知义,广泛功能的类,可以不添加后缀.如JxdHttp, JxdToast, JxdButton, JxdLabel
    • 有特殊功能的派生类,以其父类的缩写为后缀,如JxdStreamNC(NC表示UINavigationController, VC表示UIViewController),JxdProgressView, JxdCalendarView(view表示UIView)
    • 协议以Protocol为后缀, 如JxdImageEditToolProtocol, JxdSysVolumeProtocol
  5. 扩展类的属性和函数名都以 jxd_ 为前缀. 如 [string jxd_trim];
  6. 扩展类的类方法以 Jxd_ 为前缀. 如[NSString Jxd_IsEqual];
  7. 类方法,全局函数,宏定义的首字母大写.如 [JxdHttp CreateOrgInstance];
  8. 协议接口定义一般前部分为调用者信息.如 onJxdImagePasswordView:(JxdImagePasswordView *)aSender xxx…
  9. 形参一般都添加前缀 a 如: aParam, aSender
  10. 类的私有方法添加前缀 xd_. 与扩展类前缀区分

IOS开发命名规范(作废)

  1. 类名以 Jx 开头;如果类是用于项内容的, 以Item为结尾;若类管理多个项,以Manager结尾;非类以T开头,如 enum, struct 等.若为block, 则以Jx开头,Block结尾
  2. 类中私有成员以 m 开头.
  3. 常量以 k 开头
  4. 类方法,C函数及宏函数以大写字母为开头, ObjectiveC及数据库字段名以 小写字母开头. 都以驼峰命名方式进行命名
  5. 共用协议以 JxOn 开头, 协议函数名以 onJx 开头,非共用协议以 On 开头, 协议函数名以 on 开头
  6. UINavigationController 子类以 NC 结束, UIViewController 子类以 VC 结束
  7. 文件名以大写开发,ViewController以 VC 结尾; NavigationController 以 NC 结尾;
  8. 类私有成员变量以 m 开头. UIView -> view, 如 mViewContain; UIButton -> btn, UILable -> lbl
  9. 以SubVC结尾的表示它主要是作为子界面存在,较复杂的界面,如包含UITableView的,在Storyboard中实现,较简单的的界面,如只有几个UIView,UIButton的,使用NIB文件来实现,实现NIB文件的类及其对应的文件以Nib命名

Content