Version:1.0.0
Objective-C工程及代碼規范
一、工程總述
1.工程名稱為英文
工程名稱必須為英文，不能使用中文、特殊符號、其他語言，不推薦使用漢語拼音、阿拉伯數字、下劃線（特殊情況除外：客戶特別要求的情況、使用英文過于繁瑣的情況、工程名存在版本號的情況）。
2.上傳SVN服務器要求
上傳到SVN服務器之前要新建一個文件夾，并將工程文件夾放入到新建的文件夾中。上傳到SVN服務器時，應當把新建的文件夾上傳而非工程文件夾。
例如：
圖1.1上傳工程到SVN服務示例
圖1.1中當需要上傳testForStandard這個工程到SVN服務器時，需要將工程的根目錄testForStandard單獨放在一個新的文件夾testForStandardsvn中，將testForStandardsvn上傳到SVN服務器。
圖1.2文件壓縮示例
當從svn上單獨下載某一個工程后，如需壓縮源碼，只需要將工程文件夾壓縮，而不要將與工程文件夾平行的.svn文件夾一起壓縮。如圖1.2所示（顯示Mac隱藏文件的命令：defaults write com.apple.finder
AppleShowAllFiles YES隱藏Mac隱藏文件的命令：defaults write com.apple.finder AppleShowAllFiles NO）
二、工程目錄規范
1.目錄總述
1）所有文件夾為真實文件夾
所有新創建的目錄必須為真實文件夾（即在Finder中創建，而非在Xcode工程中直接New Group）。
2）文件夾需要徹底刪除
當在Xcode中刪除某一個文件夾以及文件夾中的文件時，必須要在Finder中將殘留的空文件夾刪除。防止出現文件夾重名和文件夾殘留。
2.目錄要求
1）總體要求（舉例）
圖2.1工程主目錄示例
在工程根目錄中需要存在Class、Image、Libs、Share這幾個文件夾。.h和.pch文件需要放在AppDelegate文件的下邊。工程自動生成的文件不需要改變位置。
2）class文件夾要求
圖2.2 class目錄示例
建議在class下面存在兩層子模塊。在最子模塊中進行model、view、controller分類，如有必要可以添加一個other目錄。
3）image、Libs、目錄要求
image目錄中存放圖片，每個模塊添加一個子文件件進行分類。
Libs目錄中只能存放文件夾，不允許存放單獨文件，為后續維護提供便利，另外，所有第三方之間不能橫向耦合（除幾個最常用的外），即A第三引用B第三方的東西，如有相互引用，需要進行解耦。
4）share目錄要求
圖2.3 share目錄示例
只允許存在文件夾。幾乎所有的公共類或者模塊都需要放在該目錄中。如有必要可以在某個子目錄中進行mvc的劃分。
三、命名規范
1.類命名要求
①所有類名使用JY開頭（個人封裝除外）。
②除非萬不得已或者客戶要求的情況下，使用英文命名。
③除了非常常見且比較長的單詞之外，不得使用英文縮寫。
④杜絕使用純粹的first、second這類單詞命名。
⑤盡可能不適用myCell、myView這種模式。
⑥model以及model的子類應當以Model結尾
⑦UIViewController及其子類應當以ViewController結尾
⑧UITableViewCell及其子類應當以Cell結尾
⑨封裝的view及其封裝的子類應當以View結尾
2.宏定義命名要求
1）接口
所有接口必須以URL_開頭
網絡請求的域名需要使用宏定義，宏名稱為URL_REQUEST。這里的域名不包括任何參數，所有參數都進行單獨拼接。例如：
#define URL_REQUEST @”http://www.baidu.com”
如有圖片的相對路徑需要進行拼接，需要將拼接的公共部分進行宏定義，宏名為URL_IMAGE。例如：
#define URL_IMAGE @”http://www.baidu.com/image”
如有必要可以單獨添加其他公共接口。
2）Key
將所有的與整個app相關的key和秘鑰都進行宏定義。所有的key的定義必須以KEY_開頭。例如:
#define KEY_RONGCLOUD @”xxxxxxxxx”
#define KEY_BAIDUMAP @”xxxxxxxxx”
#define KEY_UMENG @”xxxxxxxxx”
3）顏色
app中公共使用或者多處使用到顏色需要使用宏定義。例如：
#define RGBA(r,g,b,a) [UIColor colorWithRed:r/255.0f green:g/255.0fblue:b/255.0f alpha:a]
#define colorOfNav xxxxxx
#define colorOfTabBar xxxxxx
4）版本判定
可以根據需要定義版本
5）UI界面尺寸
#define HOfScreen [UIScreen mainScreen].bounds.size.height
#define WOfScreen [UIScreen mainScreen].bounds.size.width
#define HOfNavBar self.navigationController.navigationBar.frame.size.height
#define HOfTabBar self.tabBarController.tabBar.frame.size.height
6）其他常量的宏定義
建議使用extern和const修飾的常量替代宏定義。
3.變量命名要求
①變量名必須有意義。
②全局變量必須以_開頭。
③全局變量和屬性名稱建議使用控件名的縮寫和功能的組合。例如：
@property (nonatomic, strong)UILabel *lbTitle;
UILabel *_lbTitle;
@property (nonatomic, strong)UIButton *btnSubmit;
UIButton *_btnSubmit
@property (nonatomic, strong)UIImageView *imgvPortrait;
UIImageView *_imgvPortrait;
@property (nonatomic, strong)UITextField *tfUserName;
UITextField *_tfUserNamel;
@property (nonatomic, strong)UITextView *tvDetail;
UITextView *_tvDetail;
④對于一些特殊類型的變量，命名時要帶上類型，如NSArray的變量命名為xxxArray，其他的如xxxDictionary，xxxSize等。這樣就可以從名稱上知道是什么類型的變量。千萬不能將NSArray的變量命名為xxxDictionary。（這里的類型的單詞可以適當縮寫）
4.方法命名要求
①所有方法使用英文名，遵守駝峰命名規則。開頭小寫。
②所有方法名必須有實際意義。
5.圖片命名要求
圖3.1美工圖片命名
圖片命名基本按照圖3.1規則來。使用縮寫和下劃線組合。必須在文件名后加上合適的后綴（@2x、@3x）。
四、代碼實現要求
1.總體規劃
盡可能少的將變量函數做為共有的。
對網絡請求需要進行進一步的高度封裝，達到只需要執行一個方法就能夠實現網絡請求的發送，可以基于代理也可以基于block，建議使用block。
用戶信息需要在一個單例中存儲便于讀取。如果有必要需要將用戶信息存儲到本地，并且在每次程序運行時講本地存儲的用戶信息以及其他相關數據讀取到單例中，在需要時從單例中讀取。
視圖中小控件集中分布的或者相對于其他控件是獨立的模塊的區域建議進行單獨封裝，便于管理和查找。
2．用于給多人使用的公有方法的聲明
/**
*POST請求
*@param urlString請求網址
*@param parameters請求參數
*@param tag請求的標識
*@param stop是否停止其他請求隊列
*@param serializer是否取消自動解析
*@param success請求成功回調方法
*@param failure請求失敗回調方法
*/
- (void)POST_withUrlString:(NSString *)urlString
parameters:(id)parameters
stopOtherRequest:(BOOL)stop
withSerializer:(BOOL)serializer
success:(void(^)(AFHTTPRequestOperation *operation, id responseObject))success
failure:(void (^)(AFHTTPRequestOperation *operation, NSError*error))failure;
3.類中方法的實現的分類
每個類的.m文件都需要對文件內所有的方法進行合理的分類，并將每一類方法使用#param mark – xxxxxx分割。示例分類：
準備：一些數據的初始化（包括屬性和全局變量）
UI創建和初始化：UI視圖的第一次創建和初始化配置
UI邏輯：視圖的現實隱藏操作、視圖的大小變化、視圖的offset或者其他視圖邏輯
事件處理方法：一些button的各種事件的處理方法、各種手勢的處理方法
回調方法：代理方法，非主動調用的方法，建議再對回調方法根據協議或者作用使用#param mark xxxx分割。例如：tableview的所有方法都寫在#param mark tableViewDelegate的下邊。
五、代碼細節要求
1.除常見方法外都需要寫注釋說明方法的作用，有返回值的需要說明返回值的作用。
2.寫方法時當參數過長、過多時，每個參數占用一行，以冒號對齊。如：
- (void)writeFisrtNumber:(NSString *)firstStr
withNextNumber:(NSString *)nextStr
withLastNumber:(NSString *)lastStr
{}
如果方法名比參數名短，每個參數占用一行，至少縮進4個字符，且為垂直對齊（而非使用冒號
對齊）。如：
//實際上是對齊的，copy過來后有些變形
- (void)writeA:(NSString *)firstStr
withBBBBBBBBBBB:(NSString *)nextStr
withCCCCCC:(NSString *)lastStr
{}
3．Model基類需要命名為LXBaseModel，在這個類中需要實現防止鍵值不匹配的方法
4．用戶信息的存儲：
使用單例進行存儲。單例名稱統一為LXSingleInfo，單例的獲取方法名為shareInfo。使用GCD寫單例獲取方法。
5.協議的遵守建議在.m文件中遵守。非公開屬性建議在.m文件中聲明。
6.通知需要注銷。如有必要將delegate置nil。防止通知錯亂和野指針錯誤出現。
7.代碼中多次出現的常量建議使用宏定義或者定義成const修飾的常量。便于多處一起修改。
8.長字符串（超過10行）的打印測試過之后建議注釋掉。解決因打印引起的運行速度慢問題。
