iOS編程規範

自己在建立工程的時候，希望能按照這個變法規範去操作，對於以後其他人看，查，改你的代碼的時候心裡就有數了，而不是心裡說，這傻X的代碼，寫這麼亂，之類的話了。挺有用的。分享一下！

編碼規範

一、文檔結構管理

1.建立Libraries檔案夾，所有第三方庫放入其中。

2.建立Utilities檔案夾，自已封裝的類放入其中。

3.建立Constants.h標頭檔，所有的常量定義於其中。Constants.h檔案放入Main檔案組裡面。

4.每個功能塊放入一個Group，在目錄裡建立實際檔案夾管理。

5.程式資源檔放入Supporting Files檔案夾中。如.plist、資料庫資料等。

6.在Supporting Files檔案夾下建立Image、Music和Video等相關檔案夾。圖片、音頻、視頻等資源分別放入其中。圖片資源以程式邏輯架構建立相應實體檔案夾管理，若多個功能塊共用的，建立Common檔案夾，放入其中。

二、編碼規範說明：為了不影響閱讀，一個類的程式碼數盡量不要超過300行;一個方法盡量不要超過30行。有超過的在重構的時候想辦法分解。 1.每個.h檔案最開始處用簡短文字說明一下該類的功能邏輯。

2.引入其它類時，若要作為執行個體變數的在.h中引入。否則在.m中引入。

3.@interface與@implementation與#import 之間空一行。@synthesize緊接著@implementation寫。

4.a:聲明執行個體變數一律以屬性聲明。

   b:其它類要訪問的執行個體變數和方法在.h檔案中聲明，否則聲明於.m檔案中。

　c:執行個體變數及方法以功能塊放在一起，實現一個功能的連續著放在一起，另一個功能的空一行開始聲明。

　d:執行個體變數緊接@interface後開始，方法在執行個體變數後空一行開始。

　e:每個功能塊可作簡單說明，單個執行個體變數方法可不作說明，關鍵的或特殊的變數或方法單獨作說明。注釋放於變數聲明上一行。

5.類中第個功能模組以 #pragma mark -  分隔，上空兩行，下空一行。

6.NSLog在測試完成後一律刪除。

7.對於系統的常用類作執行個體變數聲明時加入尾碼：

　UIViewController:VC

   UIImage:Img　　UIImageView:ImgView　　UIView:View　　UILabel:Lbl

   UIButton:Btn　　UINavigationBar:NBar　　 UIToolBar:TBar　　UISearchBar:SBar

   UITextField:TextField　　UITextView:TextView

   NSArray:Array　　     NSMutableArray:MArray

   NSDictionary:Dict　　NSMutableDictionary:MDict

　NSString:Str　　       NSMutableString:MStr

   NSSet:Set　　　　　  NSMutableSet:MSet

8.程式中變數、方法命名盡量能以字面意思表示功能，對於需要用注釋來解釋的部分代碼，注釋以如下格式表述：

/**

 * 方法或變數說明

 * @param 參數1說明(針對方法)

 * @param 參數2說明(針對方法)

 * @return 若方法有傳回值則對傳回值作說明

 */

 

三、Xcode配置

1.全部統一用ARC。

2.用git管理代碼。

3.在項目.pch檔案加入一段去除release的NSLog代碼:

#ifndef __OPTIMIZE__

#define NSLog(...) NSLog(__VA_ARGS__)

#else

#define NSLog(...) {}

#endif

From：http://www.cnblogs.com/celestial/archive/2012/06/30/2571417.html