# okzhuhai-ios

**Repository Path**: RyanPeng/okzhuhai-ios

## Basic Information

- **Project Name**: okzhuhai-ios
- **Description**: No description available
- **Primary Language**: Objective-C
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 3
- **Created**: 2014-12-08
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

#okzhuhai-ios
命名规范：
一、全局
    1、NSLog
		格式：@“==>>文件名—>>方法名||(类型)变量名: “
		说明：
		例子：NSLog(@“==>>testController—>>testMethod||(NSString)test: %@”,test);
	
二、文件（默认：驼峰法＋首字母大写）
	1、文件名
		格式：ModuleFunctionElse
		（模块 功能 其他）
		说明：更直观得出每个方法的用途和所属模块
		例子：AppDelegate.h or UserListViewController.h

	2、全局公用文件（驼峰法）
		通用方法文件：Common.x
		通用模型文件：Model.x
		通用协议文件：Protocol.x
		通用设定文件：Config.x
		通用管理文件：Manage.x
		通用预定义文件：Define.x

	3、模块公用文件（驼峰法）
		格式：ModuleFileName.x
		（模块 其他）
		说明：用于区分不同模块的公用文件
		例子：UserDefine.h or NewsDefine.h

	4、模型文件（驼峰法）
		格式：ObjectModel
		（对象 其他）
		说明：
		例子：UserModel.h or BookModel.h

	5、视图文件（驼峰法）
		格式：ModuleFunctionView；
		（模块 功能 视图）
		说明：
		例子：UserInfoView.h or BookInfoView.h

	6、自定义文件（驼峰法）
		格式：ModuleFunctionView
		（模块 功能 视图）
		说明：
		例子：UserInfoTableViewCell.h or BookListTableViewCell.h
	
三、方法（默认：驼峰法）
	1、获得方法
		格式：getFunctionName
		说明：
		例子：getUserName or getUserInstance
	
	2、设置方法
		格式：setFunctionName
		说明：
		例子：setUserPassword or setBookTitle
	
	3、构造方法
		格式：initWithFunctionName(with params) or init(without params)
		说明：
		例子：initWithDictionary or initWithObject 
	
	4、初始化方法
		格式：initFunctionName
		说明：
		例子：initData or initView
	
	5、选择器方法
		格式：functionNameAction
		说明：
		例子：loginAction or logoutAction or jumpAction or deleteAction

	6、控件响应方法
		格式：actionItemAction
		说明：
		例子：onLoginButtonPressed or onLogoutButtonClicked

	7、执行方法
		格式：doFunctionName
		说明：
		例子：doSetUserEnable or doSetBookOnSale

	8、判断方法
		格式：isFunctionName
		说明：
		例子：isUserLogin or isBookSaleOut

	9、静态方法
		格式：stateFunctionName
		说明：
		例子：stateInitWithDictionary or stateGetUserInfo
	
	10、代理方法
		格式：functionDelegate
		说明：
		例子：userLoginDelegate or userLogoutDelegate

	11、协议方法
		格式：functionProtocol
		说明：
		例子：netProtocol or loginProtocol
	
	12、回调方法
		格式：getFunctionCallBack
		说明：
		例子：getLoginCallBack or getOrderListCallBack	

四、变量（默认：下划线＋驼峰法）
	1、通用变量
		格式：C_variableElse
		说明：
		例子：C_userName or C_loginPassword
	
	2、通用常量
		格式：C_CONST_ELSE
		说明：
		例子：C_SERVER_DEFINE_VERSION or C_SERVER_BACKUP_URL
	
	3、全局变量
		（protected / .h文件中）
		格式：H_variableElse
		说明：
		例子：H_tableView or H_userName
	4、全局常量（下划线开头＋下划线＋全大写）
		（protected / .h文件中）
		格式：H_CONST_ELSE
		说明：
		例子：H_SERVER_URL or H_SYSTEM_VERSION
	
	5、全局变量
		（private / .m文件中 / interface内）
		格式：_variableElse
		说明：
		例子：_tableView or _newsList
	
	6、全局常量（下划线开头＋下划线＋全大写）
		（private / .m文件中 / interface内）
		格式：_CONST_ELSE
		说明：
		例子：_SERVER_NAME_FROM_FILE or _CURRENT_EQUIPMENT

	7、局部变量
		（方法体内）
		格式：variableElse
		说明：
		例子：myTableViewCell or myTextField

	8、局部常量
		（方法体内）
		格式：CONST_ELSE
		说明：
		例子：MY_CONST or TEST_CONST
		
	9、局部变量
		（其他情况）
		格式：variable_else
		说明：
		例子：news_list or pictures_list

	10、临时变量
		（频繁赋值和清空 / 交换中介 / 频繁初始化和释放）
		格式：tempVariableName
		说明：
		例子：tempUserName or tempLoginName

	11、布尔变量
		格式：isVariableElse
		说明：
		例子：isUserSignedIn or isVersionUpToDate

	12、控件变量
		格式：shortcutVariableElse
		说明：
		例子：txtUserName or lbPassword or btnLogout 	

	13、默认变量
		（类型默认）
		NSArray 						*array
		NSMutableArray 				*mArray
		NSObject 					*object
		NSString 						*string
		NSInteger				 		*integer
		NSDictionary 					*dic
		NSMutableDictionary 			*mDic
		UIColor 						*color
		CGRect						*rect
		CGSize						*size
		[UIScreen mainScreen].bounds	*screenRect
		screenRect.size				*screenSize
		UIFont						*font
		CGFloat						*float
		UIAlertView					*alertView
		UITableView					*tableView
		UIWindow					*window
		UITableViewCell				*cell

	14、控件缩写
		UITextField		txt
		UILabel			lb
		UIButton			btn
		UIImage			img
		

五、注释（默认：标准语法）
	1、#pragma
		格式：#pragma tag － else
		说明：
		例子：#pragma mark - userLogin or #pragma important - netProtocol
	
	2、文件注释
		格式：	/*
				  *	project name
				  *	file name
				  *	created date
				  *	author
				*/
		说明：
		例子：	/*
				  *	TestProject
				  *	TestDelagate.h
				  *	created on 12/19/2014
				  *	by jason
				*/
	
	3、方法注释
		格式：	/*
				  *	function name
				  *	return type (if needed) or void
				  *	params (if needed) or null
				  *	author
				*/
		说明：
		例子：	/*
				  *	getCheckConfirmStatus
				  *	NSInteger
				  *	null
				  *	by jason
				*/
				or
				/*
				  *	setUserName
				  *	void
				  *	NSString *username
				  *	by jason
				*/
六、其他
	1、枚举
		格式：
		说明：
		例子：