iOS編程規范

編碼規范

一、文檔結構管理

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