Version:1.0.0

Objective-C工程及代碼規(guī)范

一、工程總述

1.工程名稱(chēng)為英文

工程名稱(chēng)必須為英文研儒，不能使用中文豫缨、特殊符號(hào)、其他語(yǔ)言端朵，不推薦使用漢語(yǔ)拼音好芭、阿拉伯?dāng)?shù)字、下劃線(xiàn)（特殊情況除外：客戶(hù)特別要求的情況冲呢、使用英文過(guò)于繁瑣的情況舍败、工程名存在版本號(hào)的情況）。

2.上傳SVN服務(wù)器要求

上傳到SVN服務(wù)器之前要新建一個(gè)文件夾敬拓，并將工程文件夾放入到新建的文件夾中邻薯。上傳到SVN服務(wù)器時(shí)，應(yīng)當(dāng)把新建的文件夾上傳而非工程文件夾乘凸。

例如：

圖1.1上傳工程到SVN服務(wù)示例

圖1.1中當(dāng)需要上傳testForStandard這個(gè)工程到SVN服務(wù)器時(shí)厕诡，需要將工程的根目錄testForStandard單獨(dú)放在一個(gè)新的文件夾testForStandardsvn中，將testForStandardsvn上傳到SVN服務(wù)器营勤。

圖1.2文件壓縮示例

當(dāng)從svn上單獨(dú)下載某一個(gè)工程后木人，如需壓縮源碼信柿，只需要將工程文件夾壓縮，而不要將與工程文件夾平行的.svn文件夾一起壓縮醒第。如圖1.2所示（顯示Mac隱藏文件的命令：defaults write com.apple.finder

AppleShowAllFiles YES隱藏Mac隱藏文件的命令：defaults write com.apple.finder AppleShowAllFiles NO）

二渔嚷、工程目錄規(guī)范

1.目錄總述

1）所有文件夾為真實(shí)文件夾

所有新創(chuàng)建的目錄必須為真實(shí)文件夾（即在Finder中創(chuàng)建，而非在Xcode工程中直接New Group）稠曼。

2）文件夾需要徹底刪除

當(dāng)在Xcode中刪除某一個(gè)文件夾以及文件夾中的文件時(shí)形病，必須要在Finder中將殘留的空文件夾刪除。防止出現(xiàn)文件夾重名和文件夾殘留霞幅。

2.目錄要求

1）總體要求（舉例）

圖2.1工程主目錄示例

在工程根目錄中需要存在Class漠吻、Image、Libs司恳、Share這幾個(gè)文件夾途乃。.h和.pch文件需要放在AppDelegate文件的下邊。工程自動(dòng)生成的文件不需要改變位置扔傅。

2）class文件夾要求

圖2.2 class目錄示例

建議在class下面存在兩層子模塊耍共。在最子模塊中進(jìn)行model、view猎塞、controller分類(lèi)试读，如有必要可以添加一個(gè)other目錄。

3）image荠耽、Libs钩骇、目錄要求

image目錄中存放圖片，每個(gè)模塊添加一個(gè)子文件件進(jìn)行分類(lèi)铝量。

Libs目錄中只能存放文件夾倘屹，不允許存放單獨(dú)文件，為后續(xù)維護(hù)提供便利慢叨，另外纽匙，所有第三方之間不能橫向耦合（除幾個(gè)最常用的外），即A第三引用B第三方的東西插爹，如有相互引用，需要進(jìn)行解耦请梢。

4）share目錄要求

圖2.3 share目錄示例

只允許存在文件夾赠尾。幾乎所有的公共類(lèi)或者模塊都需要放在該目錄中。如有必要可以在某個(gè)子目錄中進(jìn)行mvc的劃分毅弧。

三气嫁、命名規(guī)范

1.類(lèi)命名要求

①所有類(lèi)名使用JY開(kāi)頭（個(gè)人封裝除外）。

②除非萬(wàn)不得已或者客戶(hù)要求的情況下够坐，使用英文命名寸宵。

③除了非常常見(jiàn)且比較長(zhǎng)的單詞之外崖面，不得使用英文縮寫(xiě)。

④杜絕使用純粹的first梯影、second這類(lèi)單詞命名巫员。

⑤盡可能不適用myCell、myView這種模式甲棍。

⑥model以及model的子類(lèi)應(yīng)當(dāng)以Model結(jié)尾

⑦UIViewController及其子類(lèi)應(yīng)當(dāng)以ViewController結(jié)尾

⑧UITableViewCell及其子類(lèi)應(yīng)當(dāng)以Cell結(jié)尾

⑨封裝的view及其封裝的子類(lèi)應(yīng)當(dāng)以View結(jié)尾

2.宏定義命名要求

1）接口

所有接口必須以URL_開(kāi)頭

網(wǎng)絡(luò)請(qǐng)求的域名需要使用宏定義简识，宏名稱(chēng)為URL_REQUEST。這里的域名不包括任何參數(shù)感猛，所有參數(shù)都進(jìn)行單獨(dú)拼接七扰。例如：

#define URL_REQUEST @”http://www.baidu.com”

如有圖片的相對(duì)路徑需要進(jìn)行拼接，需要將拼接的公共部分進(jìn)行宏定義陪白，宏名為URL_IMAGE颈走。例如：

#define URL_IMAGE @”http://www.baidu.com/image”

如有必要可以單獨(dú)添加其他公共接口。

2）Key

將所有的與整個(gè)app相關(guān)的key和秘鑰都進(jìn)行宏定義咱士。所有的key的定義必須以KEY_開(kāi)頭立由。例如:

#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）版本判定

可以根據(jù)需要定義版本

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.變量命名要求

①變量名必須有意義拆吆。

②全局變量必須以_開(kāi)頭。

③全局變量和屬性名稱(chēng)建議使用控件名的縮寫(xiě)和功能的組合脂矫。例如：

@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;

④對(duì)于一些特殊類(lèi)型的變量枣耀，命名時(shí)要帶上類(lèi)型，如NSArray的變量命名為xxxArray庭再，其他的如xxxDictionary捞奕，xxxSize等。這樣就可以從名稱(chēng)上知道是什么類(lèi)型的變量拄轻。千萬(wàn)不能將NSArray的變量命名為xxxDictionary颅围。（這里的類(lèi)型的單詞可以適當(dāng)縮寫(xiě)）

4.方法命名要求

①所有方法使用英文名，遵守駝峰命名規(guī)則恨搓。開(kāi)頭小寫(xiě)院促。

②所有方法名必須有實(shí)際意義。

5.圖片命名要求

圖3.1美工圖片命名

圖片命名基本按照?qǐng)D3.1規(guī)則來(lái)斧抱。使用縮寫(xiě)和下劃線(xiàn)組合常拓。必須在文件名后加上合適的后綴（@2x、@3x）辉浦。

四弄抬、代碼實(shí)現(xiàn)要求

1.總體規(guī)劃

盡可能少的將變量函數(shù)做為共有的。

對(duì)網(wǎng)絡(luò)請(qǐng)求需要進(jìn)行進(jìn)一步的高度封裝宪郊，達(dá)到只需要執(zhí)行一個(gè)方法就能夠?qū)崿F(xiàn)網(wǎng)絡(luò)請(qǐng)求的發(fā)送掂恕，可以基于代理也可以基于block拖陆，建議使用block。

用戶(hù)信息需要在一個(gè)單例中存儲(chǔ)便于讀取懊亡。如果有必要需要將用戶(hù)信息存儲(chǔ)到本地依啰，并且在每次程序運(yùn)行時(shí)講本地存儲(chǔ)的用戶(hù)信息以及其他相關(guān)數(shù)據(jù)讀取到單例中，在需要時(shí)從單例中讀取斋配。

視圖中小控件集中分布的或者相對(duì)于其他控件是獨(dú)立的模塊的區(qū)域建議進(jìn)行單獨(dú)封裝孔飒，便于管理和查找。

2．用于給多人使用的公有方法的聲明

/**

*POST請(qǐng)求

*@param urlString請(qǐng)求網(wǎng)址

*@param parameters請(qǐng)求參數(shù)

*@param tag請(qǐng)求的標(biāo)識(shí)

*@param stop是否停止其他請(qǐng)求隊(duì)列

*@param serializer是否取消自動(dòng)解析

*@param success請(qǐng)求成功回調(diào)方法

*@param failure請(qǐng)求失敗回調(diào)方法

*/

- (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.類(lèi)中方法的實(shí)現(xiàn)的分類(lèi)

每個(gè)類(lèi)的.m文件都需要對(duì)文件內(nèi)所有的方法進(jìn)行合理的分類(lèi)艰争，并將每一類(lèi)方法使用#param mark – xxxxxx分割坏瞄。示例分類(lèi)：

準(zhǔn)備：一些數(shù)據(jù)的初始化（包括屬性和全局變量）

UI創(chuàng)建和初始化：UI視圖的第一次創(chuàng)建和初始化配置

UI邏輯：視圖的現(xiàn)實(shí)隱藏操作、視圖的大小變化甩卓、視圖的offset或者其他視圖邏輯

事件處理方法：一些button的各種事件的處理方法鸠匀、各種手勢(shì)的處理方法

回調(diào)方法：代理方法，非主動(dòng)調(diào)用的方法逾柿，建議再對(duì)回調(diào)方法根據(jù)協(xié)議或者作用使用#param mark xxxx分割缀棍。例如：tableview的所有方法都寫(xiě)在#param mark tableViewDelegate的下邊。

五机错、代碼細(xì)節(jié)要求

1.除常見(jiàn)方法外都需要寫(xiě)注釋說(shuō)明方法的作用爬范，有返回值的需要說(shuō)明返回值的作用。

2.寫(xiě)方法時(shí)當(dāng)參數(shù)過(guò)長(zhǎng)弱匪、過(guò)多時(shí)青瀑，每個(gè)參數(shù)占用一行，以冒號(hào)對(duì)齊萧诫。如：

- (void)writeFisrtNumber:(NSString *)firstStr

withNextNumber:(NSString *)nextStr

withLastNumber:(NSString *)lastStr

{}

如果方法名比參數(shù)名短斥难，每個(gè)參數(shù)占用一行，至少縮進(jìn)4個(gè)字符帘饶，且為垂直對(duì)齊（而非使用冒號(hào)

對(duì)齊）哑诊。如：

//實(shí)際上是對(duì)齊的，copy過(guò)來(lái)后有些變形

- (void)writeA:(NSString *)firstStr

withBBBBBBBBBBB:(NSString *)nextStr

withCCCCCC:(NSString *)lastStr

{}

3．Model基類(lèi)需要命名為L(zhǎng)XBaseModel及刻，在這個(gè)類(lèi)中需要實(shí)現(xiàn)防止鍵值不匹配的方法

4．用戶(hù)信息的存儲(chǔ)：

使用單例進(jìn)行存儲(chǔ)镀裤。單例名稱(chēng)統(tǒng)一為L(zhǎng)XSingleInfo，單例的獲取方法名為shareInfo缴饭。使用GCD寫(xiě)單例獲取方法暑劝。

5.協(xié)議的遵守建議在.m文件中遵守。非公開(kāi)屬性建議在.m文件中聲明茴扁。

6.通知需要注銷(xiāo)铃岔。如有必要將delegate置nil汪疮。防止通知錯(cuò)亂和野指針錯(cuò)誤出現(xiàn)峭火。

7.代碼中多次出現(xiàn)的常量建議使用宏定義或者定義成const修飾的常量毁习。便于多處一起修改。

8.長(zhǎng)字符串（超過(guò)10行）的打印測(cè)試過(guò)之后建議注釋掉卖丸。解決因打印引起的運(yùn)行速度慢問(wèn)題纺且。