前 言
需求是暫時(shí)的葛躏，只有變化才是永恒的，面向變化編程悠菜，而不是面向需求編程舰攒。
不要過(guò)分追求技巧，降低程序的可讀性悔醋。
簡(jiǎn)潔的代碼可以讓bug無(wú)處藏身摩窃。要寫出明顯沒(méi)有bug的代碼，而不是沒(méi)有明顯bug的代碼芬骄。
先把眼前的問(wèn)題解決掉偶芍，解決好，再考慮將來(lái)的擴(kuò)展問(wèn)題。
一边锁、命名規(guī)范
1提岔、統(tǒng)一要求
含義清楚，盡量做到不需要注釋也能了解其作用材彪，若做不到，就加注釋琴儿，使用全稱段化，不使用縮寫。
2造成、類名
大駝峰式命名：每個(gè)單詞的首字母都采用大寫字母
==例：== MFHomePageViewController
3显熏、私有變量
私有變量放在 .m 文件中聲明
以 _ 開(kāi)頭，第一個(gè)單詞首字母小寫晒屎，后面的單詞的首字母全部大寫喘蟆。
==例：== NSString *_somePrivateVariable
4、property變量
小駝峰式命名：第一個(gè)單詞以小寫字母開(kāi)始鼓鲁，后面的單詞的首字母全部大寫
屬性的關(guān)鍵字推薦按照 原子性蕴轨，讀寫，內(nèi)存管理的順序排列骇吭。
Block橙弱、NSString屬性應(yīng)該使用copy關(guān)鍵字禁止使用
synthesize關(guān)鍵詞
==例：==
typedef void (^ErrorCodeBlock) (id errorCode,NSString *message);
@property (nonatomic, readwrite, strong) UIView *headerView; //注釋
@property (nonatomic, readwrite, copy) ErrorCodeBlock errorBlock; //將block拷貝到堆中
@property (nonatomic, readwrite, copy) NSString *userName;
5、宏和常量命名
-
對(duì)于宏定義的常量
-
#define預(yù)處理定義的常量全部大寫，單詞間用 _ 分隔 - 宏定義中如果包含表達(dá)式或變量棘脐，表達(dá)式或變量必須用小括號(hào)括起來(lái)斜筐。
-
-
對(duì)于類型常量
- 對(duì)于局限于某編譯單元(實(shí)現(xiàn)文件)的常量，以字符k開(kāi)頭蛀缝，例如
kAnimationDuration顷链，且需要以static const修飾 - 對(duì)于定義于類頭文件的常量，外部可見(jiàn)内斯，則以定義該常量所在類的類名開(kāi)頭蕴潦，例如
EOCViewClassAnimationDuration, 仿照蘋果風(fēng)格，在頭文件中進(jìn)行extern聲明俘闯，在實(shí)現(xiàn)文件中定義其值
- 對(duì)于局限于某編譯單元(實(shí)現(xiàn)文件)的常量，以字符k開(kāi)頭蛀缝，例如
==例：==
//宏定義的常量
#define ANIMATION_DURATION 0.3
#define MY_MIN(A, B) ((A)>(B)?(B):(A))
//局部類型常量
static const NSTimeInterval kAnimationDuration = 0.3;
//外部可見(jiàn)類型常量
//EOCViewClass.h
extern const NSTimeInterval EOCViewClassAnimationDuration;
extern NSString *const EOCViewClassStringConstant; //字符串類型
//EOCViewClass.m
const NSTimeInterval EOCViewClassAnimationDuration = 0.3;
NSString *const EOCViewClassStringConstant = @"EOCStringConstant";
6潭苞、Enum
Enum類型的命名與類的命名規(guī)則一致
Enum中枚舉內(nèi)容的命名需要以該Enum類型名稱開(kāi)頭
NS_ENUM定義通用枚舉，NS_OPTIONS定義位移枚舉
==例：==
typedef NS_ENUM(NSInteger, UIViewAnimationTransition) {
UIViewAnimationTransitionNone,
UIViewAnimationTransitionFlipFromLeft,
UIViewAnimationTransitionFlipFromRight,
UIViewAnimationTransitionCurlUp,
UIViewAnimationTransitionCurlDown,
};
typedef NS_OPTIONS(NSUInteger, UIControlState) {
UIControlStateNormal = 0,
UIControlStateHighlighted = 1 << 0,
UIControlStateDisabled = 1 << 1,
};
7真朗、Delegate
用
delegate做后綴此疹，如<UIScrollViewDelegate>用
optional修飾可以不實(shí)現(xiàn)的方法，用required修飾必須實(shí)現(xiàn)的方法當(dāng)你的委托的方法過(guò)多, 可以拆分?jǐn)?shù)據(jù)部分和其他邏輯部分, 數(shù)據(jù)部分用
dataSource做后綴. 如<UITableViewDataSource>使用
did和will通知Delegate已經(jīng)發(fā)生的變化或?qū)⒁l(fā)生的變化遮婶。-
類的實(shí)例必須為回調(diào)方法的參數(shù)之一
- 回調(diào)方法的參數(shù)只有類自己的情況蝗碎，方法名要符合實(shí)際含義
- 回調(diào)方法存在兩個(gè)以上參數(shù)的情況，以類的名字開(kāi)頭旗扑，以表明此方法是屬于哪個(gè)類的
==例：==
@protocol UITableViewDataSource<NSObject>
@required
//回調(diào)方法存在兩個(gè)以上參數(shù)
- (NSInteger)tableView:(UITableView *)tableView numberOfRowsInSection:(NSInteger)section;
@optional
//回調(diào)方法的參數(shù)只有類自己
- (NSInteger)numberOfSectionsInTableView:(UITableView *)tableView; // Default is 1 if not implemented
@protocol UITableViewDelegate<NSObject, UIScrollViewDelegate>
@optional
//使用`did`和`will`通知`Delegate`
- (nullable NSIndexPath *)tableView:(UITableView *)tableView willSelectRowAtIndexPath:(NSIndexPath *)indexPath;
- (void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath *)indexPath;
8蹦骑、方法
方法名用小駝峰式命名
方法名不要使用
new作為前綴不要使用
and來(lái)連接屬性參數(shù)，如果方法描述兩種獨(dú)立的行為臀防，使用and來(lái)串接它們眠菇。方法實(shí)現(xiàn)時(shí)，如果參數(shù)過(guò)長(zhǎng)袱衷，則令每個(gè)參數(shù)占用一行捎废，以冒號(hào)對(duì)齊。
一般方法不使用前綴命名致燥，私有方法可以使用統(tǒng)一的前綴來(lái)分組和辨識(shí)
方法名要與對(duì)應(yīng)的參數(shù)名保持高度一致
表示對(duì)象行為的方法登疗、執(zhí)行性的方法應(yīng)該以動(dòng)詞開(kāi)頭
返回性的方法應(yīng)該以返回的內(nèi)容開(kāi)頭，但之前不要加get嫌蚤，除非是間接返回一個(gè)或多個(gè)值辐益。
可以使用情態(tài)動(dòng)詞(動(dòng)詞前面
can、should搬葬、will等)進(jìn)一步說(shuō)明屬性意思荷腊，但不要使用do或does,因?yàn)檫@些助動(dòng)詞沒(méi)什么實(shí)際意義。也不要在動(dòng)詞前使用副詞或形容詞修飾
==例：==
//不要使用 and 來(lái)連接屬性參數(shù)
- (int)runModalForDirectory:(NSString *)path file:(NSString *)name types:(NSArray *)fileTypes; //推薦
- (int)runModalForDirectory:(NSString *)path andFile:(NSString *)name andTypes:(NSArray *)fileTypes; //反對(duì)
//表示對(duì)象行為的方法急凰、執(zhí)行性的方法
- (void)insertModel:(id)model atIndex:(NSUInteger)atIndex;
- (void)selectTabViewItem:(NSTableViewItem *)tableViewItem
//返回性的方法
- (instancetype)arrayWithArray:(NSArray *)array;
//參數(shù)過(guò)長(zhǎng)的情況
- (void)longMethodWith:(NSString *)theFoo
rect:(CGRect)theRect
interval:(CGFloat)theInterval
{
//Implementation
}
//不要加get
- (NSSize) cellSize; //推薦
- (NSSize) getCellSize; //反對(duì)
//使用情態(tài)動(dòng)詞,不要使用do或does
- (BOOL)canHide; //推薦
- (BOOL)shouldCloseDocument; //推薦
- (BOOL)doesAcceptGlyphInfo; //反對(duì)
二、代碼注釋規(guī)范
優(yōu)秀的代碼大部分是可以自描述的，我們完全可以用代碼本身來(lái)表達(dá)它到底在干什么抡锈，而不需要注釋的輔助疾忍。
但并不是說(shuō)一定不能寫注釋，有以下三種情況比較適合寫注釋：
公共接口（注釋要告訴閱讀代碼的人床三，當(dāng)前類能實(shí)現(xiàn)什么功能）一罩。
涉及到比較深層專業(yè)知識(shí)的代碼（注釋要體現(xiàn)出實(shí)現(xiàn)原理和思想）。
容易產(chǎn)生歧義的代碼（但是嚴(yán)格來(lái)說(shuō)撇簿，容易讓人產(chǎn)生歧義的代碼是不允許存在的）聂渊。
除了上述這三種情況，如果別人只能依靠注釋才能讀懂你的代碼的時(shí)候四瘫，就要反思代碼出現(xiàn)了什么問(wèn)題汉嗽。
最后，對(duì)于注釋的內(nèi)容找蜜，相對(duì)于“做了什么”饼暑，更應(yīng)該說(shuō)明“為什么這么做”。
1洗做、import注釋
如果有一個(gè)以上的import語(yǔ)句弓叛，就對(duì)這些語(yǔ)句進(jìn)行分組，每個(gè)分組的注釋是可選的诚纸。
// Frameworks
#import <QuartzCore>;
// Models
#import "NYTUser.h"
// Views
#import "NYTButton.h"
#import "NYTUserView.h"
2撰筷、屬性注釋
寫在屬性之后，用兩個(gè)空格隔開(kāi)
==例：==
@property (nonatomic, readwrite, strong) UIView *headerView; //注釋
3畦徘、方法聲明注釋：
一個(gè)函數(shù)(方法)必須有一個(gè)字符串文檔來(lái)解釋毕籽，除非它：
- 非公開(kāi)，私有函數(shù)旧烧。
- 很短影钉。
- 顯而易見(jiàn)。
而其余的掘剪，包括公開(kāi)接口平委，重要的方法，分類夺谁，以及協(xié)議廉赔，都應(yīng)該伴隨文檔（注釋）：
- 以/開(kāi)始
- 第二行是總結(jié)性的語(yǔ)句
- 第三行永遠(yuǎn)是空行
- 在與第二行開(kāi)頭對(duì)齊的位置寫剩下的注釋。
建議這樣寫：
/This comment serves to demonstrate the format of a doc string.
Note that the summary line is always at most one line long, and after the opening block comment,
and each line of text is preceded by a single space.
*/
方法的注釋使用Xcode自帶注釋快捷鍵:Commond+option+/
==例：==
/**
<#Description#>
@param tableView <#tableView description#>
@param section <#section description#>
@return <#return value description#>
*/
- (CGFloat)tableView:(UITableView *)tableView heightForHeaderInSection:(NSInteger)section
{
//...
}
4匾鸥、代碼塊注釋
單行的用//+空格開(kāi)頭蜡塌，多行的采用/* */注釋
5、TODO
使用//TODO:說(shuō)明 標(biāo)記一些未完成的或完成的不盡如人意的地方
==例：==
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
//TODO:增加初始化
return YES;
}
三勿负、代碼格式化規(guī)范
1馏艾、指針*位置
定義一個(gè)對(duì)象時(shí)，指針*靠近變量
==例:== NSString *userName;
2、方法的聲明和定義
在 - 琅摩、+和 返回值之間留一個(gè)空格铁孵，方法名和第一個(gè)參數(shù)之間不留空格
==例：==
- (void)insertSubview:(UIView *)view atIndex:(NSInteger)index;
3、代碼縮進(jìn)
不要在工程里使用 Tab 鍵房资，使用空格來(lái)進(jìn)行縮進(jìn)蜕劝。在 Xcode > Preferences > Text Editing 將 Tab 和自動(dòng)縮進(jìn)都設(shè)置為 4 個(gè)空格
Method與Method之間空一行一元運(yùn)算符與變量之間沒(méi)有空格、二元運(yùn)算符與變量之間必須有空格
==例：==
!bValue
fLength = fWidth * 2;
- (void)sampleMethod1;
- (void)sampleMethod2;
4轰异、對(duì)method進(jìn)行分組
使用#pragma mark -對(duì)method進(jìn)行分組
#pragma mark - Life Cycle Methods
- (instancetype)init
- (void)dealloc
- (void)viewWillAppear:(BOOL)animated
- (void)viewDidAppear:(BOOL)animated
- (void)viewWillDisappear:(BOOL)animated
- (void)viewDidDisappear:(BOOL)animated
#pragma mark - Override Methods
#pragma mark - Intial Methods
#pragma mark - Network Methods
#pragma mark - Target Methods
#pragma mark - Public Methods
#pragma mark - Private Methods
#pragma mark - UITableViewDataSource
#pragma mark - UITableViewDelegate
#pragma mark - Lazy Loads
#pragma mark - NSCopying
#pragma mark - NSObject Methods
5岖沛、大括號(hào)寫法
對(duì)于類的
method:左括號(hào)另起一行寫(遵循蘋果官方文檔)對(duì)于其他使用場(chǎng)景
(if,for,while,switch等): 左括號(hào)跟在第一行后邊
==例：==
- (void)sampleMethod
{
BOOL someCondition = YES;
if(someCondition) {
// do something here
}
}
6、property變量
==例：==
@property (nonatomic, readwrite, strong) UIView *headerView; //注釋
四搭独、編碼規(guī)范
1婴削、if語(yǔ)句
①、須列出所有分支（窮舉所有的情況）戳稽，而且每個(gè)分支都須給出明確的結(jié)果馆蠕。
==推薦這樣寫：==
var hintStr;
if (count < 3) {
hintStr = "Good";
} else {
hintStr = "";
}
==不推薦這樣寫：==
var hintStr;
if (count < 3) {
hintStr = "Good";
}
②、不要使用過(guò)多的分支惊奇，要善于使用return來(lái)提前返回錯(cuò)誤的情況互躬，把最正確的情況放到最后返回。
==推薦這樣寫：==
if (!user.UserName) return NO;
if (!user.Password) return NO;
if (!user.Email) return NO;
return YES;
==不推薦這樣寫：==
BOOL isValid = NO;
if (user.UserName)
{
if (user.Password)
{
if (user.Email) isValid = YES;
}
}
return isValid;
③颂郎、條件過(guò)多吼渡，過(guò)長(zhǎng)的時(shí)候應(yīng)該換行。條件表達(dá)式如果很長(zhǎng)乓序，則需要將他們提取出來(lái)賦給一個(gè)BOOL值寺酪，或者抽取出一個(gè)方法
==推薦這樣寫：==
if (condition1 &&
condition2 &&
condition3 &&
condition4) {
// Do something
}
BOOL finalCondition = condition1 && condition2 && condition3 && condition4
if (finalCondition) {
// Do something
}
if ([self canDelete]){
// Do something
}
- (BOOL)canDelete
{
BOOL finalCondition1 = condition1 && condition2
BOOL finalCondition2 = condition3 && condition4
return condition1 && condition2;
}
==不推薦這樣寫：==
if (condition1 && condition2 && condition3 && condition4) {
// Do something
}
④、條件語(yǔ)句的判斷應(yīng)該是變量在右替劈，常量在左寄雀。
==推薦：==
if (6 == count) {
}
if (nil == object) {
}
if (!object) {
}
==不推薦：==
if (count == 6) {
}
if (object == nil) {
}
if (object == nil)容易誤寫成賦值語(yǔ)句,if (!object)寫法很簡(jiǎn)潔
⑤、每個(gè)分支的實(shí)現(xiàn)代碼都須被大括號(hào)包圍
==推薦：==
if (!error) {
return success;
}
==不推薦：==
if (!error)
return success;
可以如下這樣寫：
if (!error) return success;
2陨献、for語(yǔ)句
①盒犹、不可在for循環(huán)內(nèi)修改循環(huán)變量，防止for循環(huán)失去控制眨业。
for (int index = 0; index < 10; index++){
...
logicToChange(index)
}
②急膀、避免使用continue和break。
continue和break所描述的是“什么時(shí)候不做什么”龄捡，所以為了讀懂二者所在的代碼卓嫂，我們需要在頭腦里將他們?nèi)》础?/p>
其實(shí)最好不要讓這兩個(gè)東西出現(xiàn)，因?yàn)槲覀兊拇a只要體現(xiàn)出“什么時(shí)候做什么”就好了聘殖，而且通過(guò)適當(dāng)?shù)姆椒ǔ况ǎ强梢詫⑦@兩個(gè)東西消滅掉的：
- 如果出現(xiàn)了continue行瑞，只需要把continue的條件取反即可
var filteredProducts = Array<String>()
for level in products {
if level.hasPrefix("bad") {
continue
}
filteredProducts.append(level)
}
我們可以看到，通過(guò)判斷字符串里是否含有“bad”這個(gè)prefix來(lái)過(guò)濾掉一些值悍募。其實(shí)我們是可以通過(guò)取反蘑辑，來(lái)避免使用continue的：
for level in products {
if !level.hasPrefix("bad") {
filteredProducts.append(level)
}
}
- 消除
while里的break：將break的條件取反洋机，并合并到主循環(huán)里
在while里的break其實(shí)就相當(dāng)于“不存在”坠宴，既然是不存在的東西就完全可以在最開(kāi)始的條件語(yǔ)句中將其排除。
while里的break：
while (condition1) {
...
if (condition2) {
break;
}
}
取反并合并到主條件：
while (condition1 && !condition2) {
...
}
- 在有返回值的方法里消除
break：將break轉(zhuǎn)換為return立即返回
有人喜歡這樣做：在有返回值的方法里break之后绷旗，再返回某個(gè)值喜鼓。其實(shí)完全可以在break的那一行直接返回。
func hasBadProductIn(products: Array<String>) -> Bool {
var result = false
for level in products {
if level.hasPrefix("bad") {
result = true
break
}
}
return result
}
遇到錯(cuò)誤條件直接返回：
func hasBadProductIn(products: Array<String>) -> Bool {
for level in products {
if level.hasPrefix("bad") {
return true
}
}
return false
}
這樣寫的話不用特意聲明一個(gè)變量來(lái)特意保存需要返回的值衔肢，看起來(lái)非常簡(jiǎn)潔庄岖，可讀性高。
3角骤、Switch語(yǔ)句
①隅忿、每個(gè)分支都必須用大括號(hào)括起來(lái)
推薦這樣寫：
switch (integer) {
case 1: {
// ...
}
break;
case 2: {
// ...
break;
}
default:{
// ...
break;
}
}
②、使用枚舉類型時(shí)邦尊，不能有default分支背桐， 除了使用枚舉類型以外，都必須有default分支
RWTLeftMenuTopItemType menuType = RWTLeftMenuTopItemMain;
switch (menuType) {
case RWTLeftMenuTopItemMain: {
// ...
break;
}
case RWTLeftMenuTopItemShows: {
// ...
break;
}
case RWTLeftMenuTopItemSchedule: {
// ...
break;
}
}
在Switch語(yǔ)句使用枚舉類型的時(shí)候蝉揍，如果使用了default分支链峭，在將來(lái)就無(wú)法通過(guò)編譯器來(lái)檢查新增的枚舉類型了。
4又沾、函數(shù)
①弊仪、一個(gè)函數(shù)只做一件事（單一原則）
每個(gè)函數(shù)的職責(zé)都應(yīng)該劃分的很明確（就像類一樣）。
==推薦：==
dataConfiguration()
viewConfiguration()
==不推薦：==
void dataConfiguration()
{
...
viewConfiguration()
}
②杖刷、對(duì)于有返回值的函數(shù)（方法）励饵，每一個(gè)分支都必須有返回值
==推薦：==
int function()
{
if(condition1){
return count1
}else if(condition2){
return count2
}else{
return defaultCount
}
}
==不推薦：==
int function()
{
if(condition1){
return count1
}else if(condition2){
return count2
}
}
③、對(duì)輸入?yún)?shù)的正確性和有效性進(jìn)行檢查滑燃，參數(shù)錯(cuò)誤立即返回
==推薦：==
void function(param1,param2)
{
if(param1 is unavailable){
return;
}
if(param2 is unavailable){
return;
}
//Do some right thing
}
④役听、如果在不同的函數(shù)內(nèi)部有相同的功能，應(yīng)該把相同的功能抽取出來(lái)單獨(dú)作為另一個(gè)函數(shù)
原來(lái)的調(diào)用：
void logic() {
a();
b()不瓶；
if (logic1 condition) {
c();
} else {
d();
}
}
將a禾嫉，b函數(shù)抽取出來(lái)作為單獨(dú)的函數(shù)
void basicConfig() {
a();
b();
}
void logic1() {
basicConfig();
c();
}
void logic2() {
basicConfig();
d();
}
⑤、將函數(shù)內(nèi)部比較復(fù)雜的邏輯提取出來(lái)作為單獨(dú)的函數(shù)
一個(gè)函數(shù)內(nèi)的不清晰（邏輯判斷比較多蚊丐，行數(shù)較多）的那片代碼熙参，往往可以被提取出去，構(gòu)成一個(gè)新的函數(shù)麦备，然后在原來(lái)的地方調(diào)用它這樣你就可以使用有意義的函數(shù)名來(lái)代替注釋孽椰，增加程序的可讀性昭娩。
舉一個(gè)發(fā)送郵件的例子：
openEmailSite();
login();
writeTitle(title);
writeContent(content);
writeReceiver(receiver);
addAttachment(attachment);
send();
中間的部分稍微長(zhǎng)一些，我們可以將它們提取出來(lái)：
void writeEmail(title, content,receiver,attachment)
{
writeTitle(title);
writeContent(content);
writeReceiver(receiver);
addAttachment(attachment);
}
然后再看一下原來(lái)的代碼：
openEmailSite();
login();
writeEmail(title, content,receiver,attachment)
send();
參考資料：
iOS 代碼規(guī)范
iOS開(kāi)發(fā)總結(jié)之代碼規(guī)范
iOS開(kāi)發(fā)代碼規(guī)范(通用)
Objective-C開(kāi)發(fā)編碼規(guī)范
【iOS】命名規(guī)范
Ios Code Specification
Apple Coding Guidelines for Cocoa
Google Objective-C Style Guide
