iOS大牛小白都適用的開發程式碼規範通用
1. 關於命名
1> 統一要求
含義清楚,儘量做到不需要註釋也能瞭解其作用,若做不到,就加註釋
使用全稱,不適用縮寫
2> 類的命名
大駝峰式命名:每個單詞的首字母都採用大寫字母
例子:MFHomePageViewController
字尾要求
ViewController: 使用ViewController做字尾
例子: MFHomeViewController
View: 使用View做字尾
例子: MFAlertView
UITableCell:使用Cell做字尾
例子: MFNewsCell
Protocol: 使用Delegate或者DataSource作為字尾
例子: UITableViewDelegate
UI控制元件依次類推
3> 私有變數
小駝峰式命名:第一個單詞以小寫字母開始,後面的單詞的首字母全部大寫
例子:firstName、lastName
以 _ 開頭,第一個單詞首字母小寫
例子:NSString * _somePrivateVariable
私有變數放在 .m 檔案中宣告
4> property變數
小駝峰式命名例子://註釋
@property (nonatomic, copy) NSString *userName;
禁止使用synthesize關鍵詞
5> 巨集命名
全部大寫,單詞間用 _ 分隔。[不帶引數]
例子: #define THIS_IS_AN_MACRO @"THIS_IS_AN_MACRO"
以字母 k 開頭,後面遵循大駝峰命名。[不帶引數]
例子:#define kWidth self.frame.size.width
小駝峰命名。[帶引數]
#define getImageUrl(url) [NSURL URLWithString:[NSString stringWithFormat:@"%@%@",kBaseUrl,url]]
6> Enum
Enum型別的命名與類的命名規則一致
Enum中列舉內容的命名需要以該Enum型別名稱開頭,例子:

7> Delegate命名
類的例項必須為回撥方法的引數之一, 如
-(NSInteger)tableView:(UITableView*)tableViewnumberOfRowsInSection:(NSInteger)section
回撥方法的引數只有類自己的情況,方法名要符合實際含義, 如:
-(NSInteger)numberOfSectionsInTableView:(UITableView*)tableView
以類的名字開頭(回撥方法存在兩個以上引數的情況)以表明此方法是屬於哪個類的, 如:
-(UITableViewCell*)tableView:(UITableView*)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath
使用did和will通知Delegate已經發生的變化或將要發生的變化, 如:
-(NSIndexPath*)tableView:(UITableView*)tableView willSelectRowAtIndexPath:(NSIndexPath*)indexPath;
-(void)tableView:(UITableView*)tableView didSelectRowAtIndexPath:(NSIndexPath*)indexPath;
2. 私有方法及變數宣告
> 宣告位置在.m檔案中最上方,定義空的category進行宣告,例子:

3. 關於註釋
最好的程式碼是不需要註釋的 儘量通過合理的命名
良好的程式碼把含義表達清楚 在必要的地方添加註釋
註釋需要與程式碼同步更新
如果做不到命名儘量的見名知意的話,就可以適當的新增一些註釋或者mark
1> 屬性註釋
例子:學生
@property (nonatomic, strong) Student *student;
2> 方法宣告註釋:

4. 關於UI佈局
使用Interface Builder進行介面佈局
Xib檔案的命名與其對應的.h檔案保持相同
Xib檔案中控制元件的組織結構要合理,Xib檔案中控制元件需要有合理的可讀性強的命名,方便他人理解
5. 格式化程式碼
1> 指標 "*" 位置
定義一個物件時,指標 "*" 靠近變數
例子: NSString *userName;
2> 方法的宣告和定義
在 - 、+ 和 返回值 之間留一個空格,方法名和第一個引數之間不留空格
-(id)initWithNibName:(NSString *)nibNameOrNilbundle:(NSBundle *)nibBundleOrNil{...}
3> 程式碼縮排
使用 xcode 預設縮排,即 tab = 4空格
使用 xcode 中 re-indent 功能定期對程式碼格式進行整理
相同型別變數宣告需要獨行宣告,例子:

Method與Method之間空一行,例子:

4> 對method進行分組
使用 #pragma mark - 方式對類的方法進行分組,例子:

5> 大括號寫法
對於類的method: 左括號另起一行寫(遵循蘋果官方文件),例子:

對於其他使用場景: 左括號跟在第一行後邊,例子:

任何需要寫大括號的部分,不得省略
錯誤示例:
